diff --git a/README.md b/README.md index 30fd56f..5370891 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ -In testing \ No newline at end of file +# push-to-registry + +Push-to-registry is a GitHub Action for pushing an OCI-compatible image to any registry. + +## Action Inputs + +
Action input | +Description | +
---|---|
image-to-push:/td> + | (Required) Name of the image you want to push. Most likely the name you used to create it in the previous step. | +
tag | +(Optional) Tag of the image. Default value: latest. | +
registry | +(Required) Registry where to push the image. E.g https://quay.io/yourusername/yourrepo | +
username | +(Required) Username to use as credential to authenticate to the registry | +
password | +(Required) Password to use as credential to authenticate to the registry | +