Updated documentation.

9 files changed, 8 insertions, 4 deletions

diff --git a/enforcer-rule/pom.xml b/enforcer-rule/pom.xml
index c7bb00a..c7bb00a 100644..100755
--- a/enforcer-rule/pom.xml
+++ b/enforcer-rule/pom.xml
diff --git a/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java b/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java
index 670a7b0..670a7b0 100644..100755
--- a/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java
+++ b/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java
diff --git a/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java b/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java
index 57050f7..57050f7 100644..100755
--- a/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java
+++ b/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java
diff --git a/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java b/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java
index 608557e..608557e 100644..100755
--- a/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java
+++ b/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java
diff --git a/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm b/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm
index bfbf818..5251a22 100644..100755
--- a/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm
+++ b/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm
@@ -23,7 +23,7 @@ Checking a project's compatibility against older releases
   In order to check your project's compatibility against an older release, you must add the enforcer rule as a dependency to
   the maven-enforcer-plugin and then configure your the maven-enforcer-plugin to run the rule.
 
-  By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories).
+  By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories). Setting dumpDetails to true will output differences to standard output.
 
 ---
 <project>
@@ -58,6 +58,7 @@ Checking a project's compatibility against older releases
               <rules>
                 <requireBackwardCompatibility implementation="org.semver.enforcer.RequireBackwardCompatibility">
                   <compatibilityType>BACKWARD_COMPATIBLE_IMPLEMENTER</compatibilityType>
+                  <dumpDetails>true</dumpDetails>
                 </requireBackwardCompatibility>
               </rules>
             </configuration>
diff --git a/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm b/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm
index fdfd7dd..0f7bf82 100644..100755
--- a/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm
+++ b/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm
@@ -23,7 +23,7 @@ Checking a project's version against older releases
   In order to check your project's version against an older release, you must add the enforcer rule as a dependency to
   the maven-enforcer-plugin and then configure your the maven-enforcer-plugin to run the rule.
 
-  By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories).
+  By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories). Setting dumpDetails to true will output differences to standard output.
 
 ---
 <project>
@@ -56,7 +56,9 @@ Checking a project's version against older releases
             </goals>
             <configuration>
               <rules>
-                <requireSemanticVersioningConformance implementation="org.semver.enforcer.RequireSemanticVersioningConformance" />
+                <requireSemanticVersioningConformance implementation="org.semver.enforcer.RequireSemanticVersioningConformance">
+                  <dumpDetails>true</dumpDetails>
+                </requireSemanticVersioningConformance>
               </rules>
             </configuration>
           </execution>
diff --git a/enforcer-rule/src/site/apt/index.apt b/enforcer-rule/src/site/apt/index.apt
index 2887116..2887116 100644..100755
--- a/enforcer-rule/src/site/apt/index.apt
+++ b/enforcer-rule/src/site/apt/index.apt
diff --git a/enforcer-rule/src/site/apt/usage.apt.vm b/enforcer-rule/src/site/apt/usage.apt.vm
index fc9c196..fc9c196 100644..100755
--- a/enforcer-rule/src/site/apt/usage.apt.vm
+++ b/enforcer-rule/src/site/apt/usage.apt.vm
diff --git a/enforcer-rule/src/site/site.xml b/enforcer-rule/src/site/site.xml
index 6320bdf..d8d264e 100644..100755
--- a/enforcer-rule/src/site/site.xml
+++ b/enforcer-rule/src/site/site.xml
@@ -27,7 +27,8 @@
             <item name="Usage" href="usage.html" />
         </menu>
         <menu name="Examples">
-            <item name="Checking a project version number" href="examples/checking-version.html" />
+            <item name="Checking a project backward compatibility" href="examples/backward-compatibility.html" />
+            <item name="Checking a project version number" href="examples/semantic-versioning-conformance.html" />
         </menu>
         <menu ref="reports" />
     </body>