diff --git a/README.md b/README.md index 2e666f6..f8ba5ff 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ -# atcDemo \ No newline at end of file +## Сustomization ATC config file(.atc.yaml) + +Config file use syntax Yaml + +### USAGE: +## Action Inputs +- [**Path**](#action-inputs): Path to your package manager. Path shouldn't have preffix "/". +- [**Behavior**](README.md#action-inputs): What is commits will be used for create tag: `After` or `Before`. +- **Template**: Template your tag. Template should conteins {{.Version}}. +- **Branch**: . +- **RegexStr**: . + +## Example +This example will create a release when a tag is pushed: + +```yaml +path: "contents/pom.xml" +behavior: "after" +template: "v{{.Version}}" +```