From 238365db2d1ad20ffa970cbf63dfd7a1ae84c7cf Mon Sep 17 00:00:00 2001 From: divyansh42 Date: Tue, 30 Mar 2021 11:32:34 +0530 Subject: [PATCH] Add link to buildah docs in the README Signed-off-by: divyansh42 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad5b57a..5524e7e 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ [![license badge](https://img.shields.io/github/license/redhat-actions/buildah-build)](./LICENSE) [![size badge](https://img.shields.io/github/size/redhat-actions/buildah-build/dist/index.js)](./dist) -Buildah is a GitHub Action for building Docker and Kubernetes-compatible images quickly and easily. +Buildah Build is a GitHub Action for building Docker and Kubernetes-compatible images quickly and easily. -Buildah only works on Linux. GitHub's [Ubuntu Environments](https://github.com/actions/virtual-environments#available-environments) (`ubuntu-18.04` and newer) come with buildah installed. If you are not using these environments, or if you want to use a different version, you must first [install buildah](https://github.com/containers/buildah/blob/master/install.md). +[Buildah](https://github.com/containers/buildah/tree/master/docs) only works on Linux. GitHub's [Ubuntu Environments](https://github.com/actions/virtual-environments#available-environments) (`ubuntu-18.04` and newer) come with buildah installed. If you are not using these environments, or if you want to use a different version, you must first [install buildah](https://github.com/containers/buildah/blob/master/install.md). After building your image, use [push-to-registry](https://github.com/redhat-actions/push-to-registry) to push the image and make it pullable. @@ -21,7 +21,7 @@ After building your image, use [push-to-registry](https://github.com/redhat-acti -### Inputs for build from dockerfile +### [Inputs for build from dockerfile](https://github.com/containers/buildah/blob/master/docs/buildah-bud.md) | Input Name | Description | Default | | ---------- | ----------- | ------- | @@ -36,7 +36,7 @@ After building your image, use [push-to-registry](https://github.com/redhat-acti -### Inputs for build without dockerfile +### [Inputs for build without dockerfile](https://github.com/containers/buildah/blob/master/docs/buildah-config.md) | Input Name | Description | Default | | ---------- | ----------- | ------- |