Documentation cleanup

nosir · Jun 25, 2016 · df05117 · df05117
1 parent f41f6aa
commit df05117
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Cleave.js
 
 [![Travis](https://img.shields.io/travis/nosir/cleave.js.svg?maxAge=2592000)](https://travis-ci.org/nosir/cleave.js)
+[![Codacy branch grade](https://img.shields.io/codacy/grade/b1c0b0da42fa418f887076a3f7352aea/master.svg?maxAge=2592000)](https://www.codacy.com/app/nosir/cleave-js)
 
 Cleave.js has a simple purpose: to help you format input text content automatically.
 
@@ -83,7 +84,7 @@ require(['cleave.js/dist/cleave.min', 'cleave.js/dist/plugin/cleave-phone.{count
 });
 ```
 
-## ReactJS usage
+## ReactJS component usage
 
 ```js
 import React from 'react';
@@ -120,7 +121,7 @@ As you can see, here you simply use `<Cleave/>` as a normal `<input/>` field
 - Pass in the custom `options` prop
 - Add ReactJS `onChange` event listener
 
-See more in documentation: [ReactJS usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-usage.md) section
+See more in documentation: [ReactJS component usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-component-usage.md) section
 
 ## Documentation
 
@@ -129,7 +130,7 @@ See more in documentation: [ReactJS usage](https://github.com/nosir/cleave.js/bl
     - [Options](https://github.com/nosir/cleave.js/blob/master/doc/options.md)
     - [Public methods](https://github.com/nosir/cleave.js/blob/master/doc/public-methods.md)
 - [Phone lib plugin](https://github.com/nosir/cleave.js/blob/master/doc/phone-lib-plugin.md)
-- [ReactJS usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-usage.md)
+- [ReactJS component usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-component-usage.md)
 
 ## Building & Running tests
 

diff --git a/bower.json b/bower.json
@@ -1,14 +1,14 @@
 {
   "name": "cleave.js",
-  "description": "JavaScript Library for",
+  "description": "JavaScript library for formatting input text content when you are typing",
   "keywords": [
     "cleave",
     "javascript",
     "html",
     "form",
     "input"
   ],
-  "version": "0.0.4",
+  "version": "0.2.0",
   "author": {
     "name": "Max Huang",
     "email": "[email protected]",

diff --git a/codacy.json b/codacy.json
diff --git a/dist/cleave-react.min.js b/dist/cleave-react.min.js
diff --git a/dist/cleave.min.js b/dist/cleave.min.js
diff --git a/doc/constructor.md b/doc/constructor.md
@@ -1,6 +1,6 @@
 # Documentation 
 
-[Cleave.js](https://github.com/nosir/cleave.js) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Constructor
+[Cleave.js](https://github.com/nosir/cleave.js#documentation) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Constructor
 
 ## Constructor
 

diff --git a/doc/js-api.md b/doc/js-api.md
@@ -1,6 +1,6 @@
 # Documentation 
 
-[Cleave.js](https://github.com/nosir/cleave.js) > JavaScript API
+[Cleave.js](https://github.com/nosir/cleave.js#documentation) > JavaScript API
 
 - [Constructor](https://github.com/nosir/cleave.js/blob/master/doc/constructor.md)
 - [Options](https://github.com/nosir/cleave.js/blob/master/doc/options.md)

diff --git a/doc/options.md b/doc/options.md
@@ -1,6 +1,6 @@
 # Documentation 
 
-[Cleave.js](https://github.com/nosir/cleave.js) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Options
+[Cleave.js](https://github.com/nosir/cleave.js#documentation) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Options
 
 - Credit card numbers:
     - [creditCard](#creditcard)

diff --git a/doc/phone-lib-plugin.md b/doc/phone-lib-plugin.md
@@ -1,6 +1,6 @@
 # Documentation 
 
-[Cleave.js](https://github.com/nosir/cleave.js) > Phone lib plugin
+[Cleave.js](https://github.com/nosir/cleave.js#documentation) > Phone lib plugin
 
 ## Why separate phone lib as plugin