Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Really release next #70

Closed
wants to merge 2 commits into from
Closed

Really release next #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17c5667
ci: add missing semantic release
colinmeinke Jul 26, 2017
3721045
docs(readme): adjust wording
colinmeinke Jul 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
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
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
"rollup-plugin-node-resolve": "^3.0.0",
"rollup-plugin-replace": "^1.1.1",
"rollup-plugin-uglify": "^2.0.1",
"semantic-release": "^6.3.6",
"snazzy": "^7.0.0",
"standard": "^10.0.2"
},
Expand Down