-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8c53c36
commit 8f0d098
Showing
2 changed files
with
39 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Resentence | ||
|
||
Easy-to-use React component for morphing one string into another. The demo | ||
explains it much better than words can, so [go check out the | ||
demo](https://dphilipson.github.io/resentence). | ||
|
||
## Installation | ||
|
||
With Yarn: | ||
|
||
``` | ||
yarn add resentence | ||
``` | ||
|
||
Or with NPM: | ||
|
||
``` | ||
npm install resentence | ||
``` | ||
|
||
## Usage | ||
|
||
Wrap text you want to animate in a `<Resentence>` component: | ||
|
||
```tsx | ||
import Resentence from "resentence"; | ||
|
||
// ... | ||
|
||
render() { | ||
return <Resentence className="my-text">{this.props.text}</Resentence>; | ||
} | ||
``` | ||
|
||
That's it. See the `demo/` directory for examples, but that's the entire API. | ||
|
||
Copyright © 2019 David Philipson |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters