Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
dphilipson committed Jan 3, 2019
1 parent 8c53c36 commit 8f0d098
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
37 changes: 37 additions & 0 deletions README.md
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
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"react-spring": "^7.2.7"
},
"peerDependencies": {
"react": "*",
"react-dom": "*"
"react": ">= 16.4.0",
"react-dom": ">= 16.4.0"
}
}

0 comments on commit 8f0d098

Please sign in to comment.