From 4dd3914c398712a376cf7e8312a79ef93e973c6a Mon Sep 17 00:00:00 2001
From: Va Da <streamich@gmail.com>
Date: Wed, 6 Jun 2018 09:31:06 +0100
Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20improve=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md       | 46 ++++++++++++++++++++++++++++++++++++---------
 build/readme.md | 50 ++++++++++++++++++++++++++++++++++++++++---------
 2 files changed, 78 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 3d1b0680..8694c370 100644
--- 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
index 68f86add..d55df01a 100644
--- 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
 
 ```