Merge pull request #33 from kemitix/update-readme

Update readme

README.md

@@ -10,30 +10,59 @@ This Maven Parent POM several preconfigured plugins.
     <parent>
         <groupId>net.kemitix</groupId>
         <artifactId>kemitix-parent</artifactId>
+        <version>RELEASE</version>
     </parent>
 
+## Versions
+
+If you want to override the version or configuration values of any of the
+plugins configured by this parent, you can set the following properties to the
+desired value.
+
+property|value
+--------|-------------
+project.build.sourceEncoding|UTF-8
+project.reporting.outputEncoding|UTF-8
+kemitix.build.directory|target
+maven-javadoc-plugin.version|2.10.4
+maven-source-plugin.version|3.0.1
+maven-gpg-plugin.version|1.6
+maven-deploy-plugin.version|2.8.2
+maven-checkstyle-plugin.version|2.17
+checkstyle.version|7.1
+sevntu-checkstyle-maven-plugin.version|1.21.0
+maven-compiler-plugin.version|3.5.1
+maven-surefire-plugin.version|2.19.1
+maven-failsafe-plugin.version|2.19.1
+maven-pmd-plugin.version|3.6
+findbugs-maven-plugin.version|3.0.4
+jacoco-maven-plugin.version|0.7.7.201606060606
+highwheel-maven.version|1.2
+maven-project-info-reports-plugin.version|2.9
+maven-jxr-plugin.version|2.5
+jacoco-class-line-covered-ratio|0.50
+jacoco-class-instruction-covered-ratio|0.80
+jacoco-class-missed-count-maximum|0
+
 ## Maven Checkstyle Plugin
 
 The [Maven Checkstyle Plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/)
 uses the latest version of the Checkstyle library
-([Release Notes](http://checkstyle.sourceforge.net/releasenotes.html)).
+([Release Notes](http://checkstyle.sourceforge.net/releasenotes.html)) and the
+[Sevntu](http://sevntu-checkstyle.github.io/sevntu.checkstyle/) library.
 
-Also available for you to use are the rules defined by
+As from version 2.0.0 you no longer provide a `checkstyle.xml` file. Any file you
-[Sevntu](http://sevntu-checkstyle.github.io/sevntu.checkstyle/).
+provide will be ignored unless you re-configure the maven-checkstyle-plugin yourself.
 
-<strong>Your project <em>must</em> provide a `checkstyle.xml` file in it's root
+The ruleset that will be used is defined in
-directory.</strong> See the Checkstyle Plugin homepage for `sun_checks.xml` and
+[kemitix-checkstyle-ruleset](https://github.com/kemitix/kemitix-checkstyle-ruleset).
-`google_checks.xml` examples. There is a modified version of `sun_checks.xml`
+See the that project's `README.md` file for details on the ruleset.
-bundled in the source jar as `checkstyle.xml`.
-
-Your build will fail on any violations or errors found. You can modify your
-`checkstyle.xml` to suite your own needs.
 
 ### Configuration
 
 Ref [checkstyle:check](https://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html)
 
-* configLocation: checkstyle.xml
+* configLocation: [checkstyle.xml](https://github.com/kemitix/kemitix-checkstyle-ruleset/blob/master/src/main/resources/net/kemitix/checkstyle.xml)
 * consoleOutput: true
 * encoding: UTF-8
 * failOnViolation: true