diff --git a/README.md b/README.md index c02f151..14b0b5a 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,14 @@ Maven Plugin linter for [conventional commits](https://www.conventionalcommits.o # How to use -Add plugin to pom.xml (to plugins section) +Add the plugin to your `pom.xml` file to the plugins section. ```XML + com.github.volodya-lombrozo conventional-commit-linter - 0.0.5 - - ALL - + 0.0.6 @@ -27,12 +25,48 @@ Add plugin to pom.xml (to plugins section) ``` + The default maven phase is **validate**. +## Change scan mode + Available scan modes: -* ALL - the plugin will scan all repository commits messages one by one starting from the earliest. Conventional commits - format will be used. -* LAST - the plugin will scan only the last commit. Conventional commits format will be used. -* NOTHING - the plugin will scan nothing. Validation will always be **successful** regardless of the commit messages. -* FAIL - the plugin will scan nothing. Validation will always be **failed** regardless of the commit messages. \ No newline at end of file +* **ALL** - the plugin will scan all repository commits messages one by one starting from the earliest. Conventional + commits format will be used. +* **LAST** - the plugin will scan only the last commit. Conventional commits format will be used. +* **NOTHING** - the plugin will scan nothing. Validation will always be **successful** regardless of the commit + messages. +* **FAIL** - the plugin will scan nothing. Validation will always be **failed** regardless of the commit messages. + +The default plugin mode is the **LAST**. +In order to change a scan mode you could add the next configuration to your plugin: + +```xml + + + ALL + +``` + +The full plugin example: + +```xml + + com.github.volodya-lombrozo + conventional-commit-linter + 0.0.6 + + FAIL + + + + + + scan + + + + + +``` \ No newline at end of file