Merge pull request #1 from weahead/feature/update-readme

chore(readme): update readme with Commitizen config
weahead · Sep 10, 2019 · 256a4b2 · 256a4b2
2 parents 5295be6 + 5206428
commit 256a4b2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,14 @@ A `.huskyrc.js` file will automatically be created in the root of your project w
 module.exports = require('@weahead/husky-config');
 ```
 
+#### Turn off Commitizen
+
+Use this config if you don't want help from [Commitizen](http://commitizen.github.io/cz-cli/) to create commit messages:
+
+`git config --global wa.noautocz true`
+
+**_Note!_** This does not turn off the linting of your commit messages, it only turns off the help from `Commitizen` when creating the commit message.
+
 ## License
 
 [X11](LICENSE)