diff --git a/README.md b/README.md index 3cbcaef..a4816aa 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,50 @@ # kemitix-checkstyle-ruleset -Provides an extensive Checkstyle ruleset for use with `kemitix-parent`. +Provides an extensive Checkstyle ruleset for use with Apache's `maven-checkstyle-plugin`. -The ruleset includes rules from both the core Checkstyle 7.0 library and -from the Sevntu-Checkstyle 1.21.0 library. +The ruleset includes checks from both the core Checkstyle library and from the Sevntu-Checkstyle library. + +## Requirements + +* [maven-checkstyle-plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/) 2.17+ +* [Checkstyle](http://checkstyle.sourceforge.net/) 7.0+ +* [Sevntu-checkstyle](http://sevntu-checkstyle.github.io/sevntu.checkstyle/) 1.21.0+ + +## Usage + +To use this ruleset in your `maven-checkstyle-plugin` configuration add `checkstyle`, `sevntu-checkstyle-maven-plugin` and `kemitix-checktyle-ruleset` as dependencies of the `maven-checkstyle-plugin`. + +You need to include `checkstyle` as the version bundled with the `maven-checkstyle-plugin` is not up-to-date enough. + +```` + + 7.0 + 1.21.0 + 1.0.0 + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + com.puppycrawl.tools + checkstyle + ${checkstyle.version} + + + com.github.sevntu.checkstyle + sevntu-checkstyle-maven-plugin + ${sevntu-checkstyle-maven-plugin.version} + + + net.kemitix + kemitix-checkstyle-ruleset + ${kemitix-checkstyle-ruleset.version} + + + +```` ## Rules Enabled