Skip to content

Commit df05117

Browse files
committed
Documentation cleanup
1 parent f41f6aa commit df05117

12 files changed

+18
-38
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Cleave.js
22

33
[![Travis](https://img.shields.io/travis/nosir/cleave.js.svg?maxAge=2592000)](https://travis-ci.org/nosir/cleave.js)
4+
[![Codacy branch grade](https://img.shields.io/codacy/grade/b1c0b0da42fa418f887076a3f7352aea/master.svg?maxAge=2592000)](https://www.codacy.com/app/nosir/cleave-js)
45

56
Cleave.js has a simple purpose: to help you format input text content automatically.
67

@@ -83,7 +84,7 @@ require(['cleave.js/dist/cleave.min', 'cleave.js/dist/plugin/cleave-phone.{count
8384
});
8485
```
8586

86-
## ReactJS usage
87+
## ReactJS component usage
8788

8889
```js
8990
import React from 'react';
@@ -120,7 +121,7 @@ As you can see, here you simply use `<Cleave/>` as a normal `<input/>` field
120121
- Pass in the custom `options` prop
121122
- Add ReactJS `onChange` event listener
122123

123-
See more in documentation: [ReactJS usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-usage.md) section
124+
See more in documentation: [ReactJS component usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-component-usage.md) section
124125

125126
## Documentation
126127

@@ -129,7 +130,7 @@ See more in documentation: [ReactJS usage](https://github.com/nosir/cleave.js/bl
129130
- [Options](https://github.com/nosir/cleave.js/blob/master/doc/options.md)
130131
- [Public methods](https://github.com/nosir/cleave.js/blob/master/doc/public-methods.md)
131132
- [Phone lib plugin](https://github.com/nosir/cleave.js/blob/master/doc/phone-lib-plugin.md)
132-
- [ReactJS usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-usage.md)
133+
- [ReactJS component usage](https://github.com/nosir/cleave.js/blob/master/doc/reactjs-component-usage.md)
133134

134135
## Building & Running tests
135136

bower.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
"name": "cleave.js",
3-
"description": "JavaScript Library for",
3+
"description": "JavaScript library for formatting input text content when you are typing",
44
"keywords": [
55
"cleave",
66
"javascript",
77
"html",
88
"form",
99
"input"
1010
],
11-
"version": "0.0.4",
11+
"version": "0.2.0",
1212
"author": {
1313
"name": "Max Huang",
1414
"email": "[email protected]",

codacy.json

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

dist/cleave-react.min.js

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/cleave.min.js

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/constructor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
[Cleave.js](https://github.com/nosir/cleave.js) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Constructor
3+
[Cleave.js](https://github.com/nosir/cleave.js#documentation) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Constructor
44

55
## Constructor
66

doc/js-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
[Cleave.js](https://github.com/nosir/cleave.js) > JavaScript API
3+
[Cleave.js](https://github.com/nosir/cleave.js#documentation) > JavaScript API
44

55
- [Constructor](https://github.com/nosir/cleave.js/blob/master/doc/constructor.md)
66
- [Options](https://github.com/nosir/cleave.js/blob/master/doc/options.md)

doc/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
[Cleave.js](https://github.com/nosir/cleave.js) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Options
3+
[Cleave.js](https://github.com/nosir/cleave.js#documentation) > [JavaScript API](https://github.com/nosir/cleave.js/blob/master/doc/js-api.md) > Options
44

55
- Credit card numbers:
66
- [creditCard](#creditcard)

doc/phone-lib-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
[Cleave.js](https://github.com/nosir/cleave.js) > Phone lib plugin
3+
[Cleave.js](https://github.com/nosir/cleave.js#documentation) > Phone lib plugin
44

55
## Why separate phone lib as plugin
66

0 commit comments

Comments
 (0)