Skip to content

Commit

Permalink
docs(readme): adjust wording
Browse files Browse the repository at this point in the history
  • Loading branch information
colinmeinke committed Jul 26, 2017
1 parent cdf6991 commit 5cf8dc0
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ As well as all the things that you would expect an SVG animation library to
include, Wilderness has some very powerful features:

- **Shape morphing**. Morph from anything, to anything.
- **Full timeline control**. Sequence multiple shapes on a timeline. Control
playback how you want.
- **Full timeline control**. Sequence multiple shapes on a timeline. Use the
powerful playback controls.
- **Middleware**. Create your own functions to transform shapes during animation.

Here is a quick example that shows just how simple it is to morph between two
Expand All @@ -24,7 +24,6 @@ const square = svg.querySelector('.square')
const circle = svg.querySelector('.circle')

// 1. Create a shape
// This will create a shape with two keyframes
const morph = shape({ el: square }, { el: circle })

// 2. Place the shape on a timeline
Expand All @@ -39,13 +38,13 @@ play(animation)
```

Full documentation will appear shortly at
[wilderness.now.sh](https://wilderness.now.sh). In the meantime check out the [examples directory](./examples) in this repository.
[wilderness.now.sh](https://wilderness.now.sh). In the meantime check out the [examples directory](./examples).

## Installation

Wilderness can be used as [an ES2015 module](#es2015-module),
[required with commonjs](#commonjs) or
[loaded with an HTML script element](#umd).
[loaded with a script element](#umd).

First, get a copy of Wilderness by installing the npm distribution:

Expand Down

0 comments on commit 5cf8dc0

Please sign in to comment.