Doc fix for #93

llorllale · Aug 6, 2018 · 65ee1fc · 65ee1fc
1 parent a28cfca
commit 65ee1fc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -27,8 +27,9 @@ None of the other changelog plugins have the right *combination* of features tha
 
 ## Usage
 
-Include the plugin in your pom. All configurations have default values and are optional (values shown below are default).
-They are also available from the command line if you prefix them with `loggit.` (eg. `-Dloggit.maxEntries`).
+Include the plugin in your pom. Its only goal is **changelog** and is set to execute in the `prepare-package` phase by default.
+All configurations have default values and are optional (values shown below are default).
+They are also available from the command line if you prefix them with `loggit.` (eg. `mvn loggit:changelog -Dloggit.maxEntries=50`).
 
 ```xml
   <build>

diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
@@ -50,8 +50,9 @@ $h2 Non goals
 
 $h2 Usage
 
-Include the plugin in your pom. All configurations have default values and are optional (values shown below are default).
-They are also available from the command line if you prefix them with `loggit.` (eg. `-Dloggit.maxEntries`).
+Include the plugin in your pom. Its only goal is **changelog** and is set to execute in the `prepare-package` phase by default.
+All configurations have default values and are optional (values shown below are default).
+They are also available from the command line if you prefix them with `loggit.` (eg. `mvn loggit:changelog -Dloggit.maxEntries=50`).
 
     <build>
       <plugins>