Skip to content

Commit f3b3f4d

Browse files
committed
Merge pull request #1 from jorilallo/readme-patch
Corrected `Keyframe`s in Readme
2 parents 4cfda59 + 6bb81a1 commit f3b3f4d

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

Readme.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example will render contents in `Frame` one at a time every 500 ms
1010

1111
```js
1212
import { render } from 'react-dom';
13-
import { KeyFrames, Frame } from 'react-keyframes';
13+
import { Keyframes, Frame } from 'react-keyframes';
1414

1515
render(
1616
<Keyframes>
@@ -32,11 +32,11 @@ $ npm install react-keyframes --save
3232

3333
### API
3434

35-
#### KeyFrames
36-
**`<KeyFrames { component = 'span', delay = 0, onStart, onEnd } />`**
35+
#### Keyframes
36+
**`<Keyframes { component = 'span', delay = 0, onStart, onEnd } />`**
3737

38-
- Use `import { KeyFrames } from 'react-keyframes'` or `require('react-keyframes').KeyFrames`.
39-
- The `component` prop specifies what component `KeyFrames` renders as.
38+
- Use `import { Keyframes } from 'react-keyframes'` or `require('react-keyframes').Keyframes`.
39+
- The `component` prop specifies what component `Keyframes` renders as.
4040
- The `delay` prop specifies when the animation should start (millisecond).
4141
- The `onStart` function is invoked upon animation start
4242
- The `onEnd` function is invoked upon animation end
@@ -50,10 +50,10 @@ $ npm install react-keyframes --save
5050

5151
class extends Component {
5252
render () {
53-
return <KeyFrames component="pre" delay={300} className="animation-test">
53+
return <Keyframes component="pre" delay={300} className="animation-test">
5454
<Frame>foo</Frame>
5555
<Frame>bar</Frame>
56-
</KeyFrames>;
56+
</Keyframes>;
5757
}
5858
}
5959
```
@@ -73,10 +73,10 @@ $ npm install react-keyframes --save
7373

7474
class extends Component {
7575
render () {
76-
return <KeyFrames>
76+
return <Keyframes>
7777
<Frame duration={100}>foo</Frame>
7878
<Frame duration={200}>bar</Frame>
79-
</KeyFrames>;
79+
</Keyframes>;
8080
}
8181
}
8282
```

0 commit comments

Comments
 (0)