docs: add links to configuration guides

conventional-changelog · Oct 9, 2017 · 2f5ef25 · 2f5ef25
1 parent 5431899
commit 2f5ef25
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,10 +16,16 @@
 ## Getting started
 
 ```sh
+# Install commitlint cli and angular config
 npm install --save-dev @commitlint/{config-angular,cli}
+
+# Configure commitlint to use angular config
 echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js
 ```
 
+* [Local setup](http://marionebl.github.io/commitlint/#/guides-local-setup) - Lint messages on commit with husky
+* [CI setup](http://marionebl.github.io/commitlint/#/guides-ci-setup) - Lint messages during CI builds
+
 ## CLI
 
 * Primary way to interact with commitlint.