diff --git a/README.md b/README.md new file mode 100644 index 0000000..6baf059 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +## Docker build + +### Description + +Builds a docker image + +### Inputs + +| name | description | required | default | +| --- | --- | --- | --- | +| `name` |
Directory name
| `true` | `""` | +| `REGISTRY_USERNAME` |Registry username
| `true` | `""` | +| `REGISTRY_TOKEN` |Registry token
| `true` | `""` | +| `DOCKER_USERNAME` |Docker username
| `true` | `""` | +| `DOCKER_PASSWORD` |Docker password
| `true` | `""` | + + +### Runs + +This action is a `composite` action. + +### Usage + +```yaml +- uses: ***PROJECT***@***VERSION*** + with: + name: + # Directory name + # + # Required: true + # Default: "" + + REGISTRY_USERNAME: + # Registry username + # + # Required: true + # Default: "" + + REGISTRY_TOKEN: + # Registry token + # + # Required: true + # Default: "" + + DOCKER_USERNAME: + # Docker username + # + # Required: true + # Default: "" + + DOCKER_PASSWORD: + # Docker password + # + # Required: true + # Default: "" +``` + + +