diff --git a/README.md b/README.md index 096d9b6..67a0b71 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,22 @@ To use this ruleset in your `maven-checkstyle-plugin` configuration add `checkst You need to include `checkstyle` as the version bundled with the `maven-checkstyle-plugin` is not up-to-date enough. +Select the `configLocation` for the level of strictness required: + +* checkstyle-1-layout.xml +* checkstyle-2-naming.xml +* checkstyle-3-javadoc.xml +* checkstyle-4-tweaks.xml +* checkstyle-5-complexity.xml + +Only specify a single `configLocation` as each increasing level includes all the rules +from the previous. + ```` - 7.0 - 1.21.0 - 0.1.1 + 7.3 + 1.22.0 + 0.2.0 @@ -53,10 +64,10 @@ You need to include `checkstyle` as the version bundled with the `maven-checksty kemitix-checkstyle-ruleset ${kemitix-checkstyle-ruleset.version} - - net/kemitix/checkstyle.xml - + + net/kemitix/checkstyle-5-complexity.xml +