diff --git a/README.md b/README.md index ada93a84..130a3f67 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,15 @@ For example: ```yml feature: ['feature/*', 'feat/*'] fix: fix/* -chore: chore/* +chore :hammer:: chore/* ``` Then if a pull request is opened with the branch name `feature/218-add-emoji-support` the Action will automatically apply the `feature` label. +Similarly, if a pull requests is opened with the branch name `fix/weird-bug` or `chore/annual-refactoring-job`, the Action will apply the `fix` or `chore 🔨` label, respectively. + +If the label does not exist in your repo, a new one will be created (with no color and blank description), but it will not be permanently saved to the `github.com//labels` page. + ### Wildcard branches in configuration You can use `*` as a wildcard for matching multiple branch names. See https://www.npmjs.com/package/matcher for more information about wildcard options.