Update README with --sloppy option

lo1tuma · May 20, 2017 · aad4a93 · aad4a93
1 parent 5bbe35c
commit aad4a93
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 
 The main features:
 
-* Writes in a `CHANGELOG.md` from merged GitHub pull requests since the last tag. This works by 
+* Writes in a `CHANGELOG.md` from merged GitHub pull requests since the last tag. This works by
     * first getting a list of all tags
     * than removing all tags that are not compatible to [semver versioning](http://semver.org/)
     * sort the tags
@@ -70,9 +70,9 @@ As `pr-log` reads repository information from your project you have to add the `
 
 ## Usage
 
-To create or update your changelog run 
+To create or update your changelog run
 
-```pr-log <version-number>``` where `version-number` is the name of this release
+```pr-log [options] <version-number>``` where `version-number` is the name of this release
 
 Example:
 
@@ -96,6 +96,12 @@ Given the following setup:
 * Fix some spelling mistakes in documentation. (#22)
 ```
 
+### Options
+
+#### --sloppy
+
+The `--sloppy` option defaults to false. When set, it allows `pr-log` to generate a changelog even when you are not on the `master` branch. This should not be used in production!
+
 ### Correct usage makes a clean and complete changelog
 
 If you want your changelog to be complete and clean you have to follow these rules: