Merge pull request #136 from Lee-W/remove-redundant-readme

Remove redundant readme

Author: woile

MANIFEST.in

@@ -1,5 +1,4 @@
 include .bumpversion.cfg
-include README.rst
 include LICENSE
 include commitizen/cz/*.txt
 global-exclude *.py[cod] __pycache__ *.so *.dylib

README.rst

@@ -14,11 +14,13 @@ python -m pip install pre-commit
 * Step 2: Create `.pre-commit-config.yaml` at your root directory with the following content
 
 ```yaml
-- repo: https://github.com/Woile/commitizen
-  rev: master
-  stages: [commit-msg]
-  hooks:
-    - id: commitizen
+---
+repos:
+  - repo: https://github.com/Woile/commitizen
+    rev: v1.16.2
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
 ```
 
 * Step 3: Install the configuration into git hook through `pre-commit`

docs/index.md renamed to docs/README.md

@@ -9,7 +9,7 @@ repo_url: https://github.com/Woile/commitizen
 edit_uri: ""
 
 nav:
-    - Introduction: 'index.md'
+    - Introduction: 'README.md'
     - Configuration: 'config.md'
     - Commands:
         - Bump: 'bump.md'
@@ -26,4 +26,4 @@ markdown_extensions:
       guess_lang: false
   - admonition
   - codehilite
-  - extra
+  - extra

docs/check.md

@@ -34,7 +34,7 @@ description = "Python commitizen client tool"
 authors = ["Santiago Fraire <santiwilly@gmail.com>"]
 license = "MIT"
 keywords = ["commitizen", "conventional", "commits", "git"]
-readme = "README.rst"
+readme = "docs/README.md"
 homepage = "https://github.com/woile/commitizen"
 classifiers = [
     "License :: OSI Approved :: MIT License",