docs(): add commitzen badge to readme

leoforfree · Nov 13, 2015 · 5959589 · 5959589
1 parent 8f70b22
commit 5959589
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,12 @@
 
 This is a customizable Commitizen plugin. You can specify the commit types, scopes and override scopes for specific types.
 
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+
 Steps:
 - install commitizen case you don't have it: `npm install -g commitizen`
-- install the cz-customizable: `npm install cz-customizable`
+- install the cz-customizable: `npm install cz-customizable --save-dev`
 - configure `commitizen` to use `cz-customizable` as plugin. There are a few ways to do this.
   - Option 1: change your `package.json`
   ```

diff --git a/package.json b/package.json
@@ -20,6 +20,12 @@
   "devDependencies": {
     "jasmine-node": "1.14.5",
     "rewire": "2.4.0",
-    "semantic-release": "^4.3.5"
+    "semantic-release": "4.3.5",
+    "cz-conventional-changelog":"1.1.4"
+  },
+  "config":{
+    "commitizen":{
+      "path":"./node_modules/cz-conventional-changelog"
+    }
   }
 }