Merge pull request #66 from FelixVita/patch-1

Update README to explain how to use labels w/ emojis
TimonVS · Nov 13, 2022 · e0d9125 · e0d9125
2 parents 6f5dd39 + 8ad7547
commit e0d9125
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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/<your_repo>/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.