docs: ✏️ improve README

JeromeFitz · Jun 6, 2018 · 4dd3914 · 4dd3914
1 parent 323f0e8
commit 4dd3914
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,30 +1,58 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-# mol-conventional-changelog
+# git-cz
+
+## Usage
 
-## Setup
 
-Install commitizen
+##### Without installation
 
 ```shell
-npm install -g commitizen
+npx git-cz
 ```
 
-Install the `mol-conventional-changelog` package.
+##### Install globally standalone
 
 ```shell
-npm install --save-dev mol-conventional-changelog
+npm install -g git-cz
+git-cz
 ```
 
-Init commitizen configuration
+##### Install locally with Commitizen
 
 ```shell
-commitizen init mol-conventional-changelog --save-dev --save-exact
+npm install -g commitizen
+npm install --save-dev git-cz
 ```
 
-## Usage
+and add to `package.json`:
 
+```json
+{
+  "config": {
+    "commitizen": {
+      "path": "git-cz"
+    }
+  },
+}
 ```
+
+now run:
+
+```shell
+git cz
+```
+
+##### Install globally with Commitizen
+
+```shell
+npm install -g commitizen git-cz
+commitizen init git-cz --save-dev --save-exact
+```
+
+now run:
+
+```shell
 git cz
 ```
 

diff --git a/build/readme.md b/build/readme.md
@@ -1,33 +1,65 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-# mol-conventional-changelog
+# git-cz
+
+## Usage
 
-## Setup
 
-Install commitizen
+##### Without installation
 
 ```shell
-npm install -g commitizen
+npx git-cz
 ```
 
-Install the `mol-conventional-changelog` package.
+
+##### Install globally standalone
 
 ```shell
-npm install --save-dev mol-conventional-changelog
+npm install -g git-cz
+git-cz
 ```
 
-Init commitizen configuration
+
+##### Install locally with Commitizen
 
 ```shell
-commitizen init mol-conventional-changelog --save-dev --save-exact
+npm install -g commitizen
+npm install --save-dev git-cz
 ```
 
-## Usage
+and add to `package.json`:
 
+```json
+{
+  "config": {
+    "commitizen": {
+      "path": "git-cz"
+    }
+  },
+}
 ```
+
+now run:
+
+```shell
 git cz
 ```
 
+
+##### Install globally with Commitizen
+
+```shell
+npm install -g commitizen git-cz
+commitizen init git-cz --save-dev --save-exact
+```
+
+now run:
+
+```shell
+git cz
+```
+
+
 ## Examples
 
 ```