Skip to content

Commit 5bba064

Browse files
committed
Cleaner documentation
1 parent b4b64e2 commit 5bba064

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

readme.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ render(
2525
);
2626
```
2727

28-
## Documentation
28+
## Usage
2929

30-
### Installation
30+
Firstly, install the package:
3131

3232
```js
33-
$ npm install react-keyframes --save
33+
$ npm install --save react-keyframes
3434
```
3535

36-
### API
36+
## API
3737

38-
#### Keyframes
38+
### Keyframes
3939
**`<Keyframes { component = 'span', delay = 0, loop = 1, onStart, onEnd } />`**
4040

4141
- Use `import { Keyframes } from 'react-keyframes'` or `require('react-keyframes').Keyframes`.
@@ -62,7 +62,7 @@ $ npm install react-keyframes --save
6262
}
6363
```
6464

65-
#### Frame
65+
### Frame
6666

6767
**`<Frame { duration = 0 } />`**
6868

@@ -85,12 +85,11 @@ $ npm install react-keyframes --save
8585
}
8686
```
8787

88-
### Contributing
88+
## Contributing
8989

90-
- Run `gulp help` to see available tasks.
91-
- Before submitting a PR, please run `gulp lint` and `npm test`.
92-
- We use [`standard`](https://github.com/feross/standard) + semicolons.
93-
- Please [be welcoming](http://contributor-covenant.org/).
90+
- Run `npm run build` to transpile the source code
91+
- Before submitting a PR, please run npm test`
92+
- Please [be welcoming](http://contributor-covenant.org/)
9493

9594
## Author
9695

0 commit comments

Comments
 (0)