Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sghall committed Apr 18, 2017
1 parent bd18c09 commit 8485634
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
## Resonance

Data driven SVG transitions in React. This is an experimental library and will have breaking changes going forward.
Data driven transitons in React.

[Documentation](https://sghall.github.io/resonance/#/documentation/node-group) and [examples](https://sghall.github.io/resonance/#/examples/states-by-age) are a work in progress. Feedback welcome.
Harnesses the awesome [d3-timer](https://github.com/d3/d3-timer) which can efficiently schedule 1000s of animated transitions.
Provides an interface for utilizing the various [d3 interpolaters](https://github.com/d3/d3-interpolate) to make state transitions.

The basic idea is that, while d3 stores data and schedules transitions against DOM nodes. Resonance takes the same sheduling mechanism and much of the same tooling (d3 4.0 modules) and instead schedules transitions against your React components.
It handles interrupts, applying [d3-ease](https://github.com/d3/d3-timer) functions and stopping in-flight transitions on unmount for you.

This is an experimental library and will have breaking changes going forward.
I started working on this idea with [React Fiber](http://isfiberreadyyet.com/) in mind. Fiber will allow you to set priority levels on state updates. Fiber is not ready yet and, last I heard, setting of priority levels won't land until React 17.
In the mean time, the library and the example site are using React 15.5 and the performance is pretty good.

[examples](https://sghall.github.io/resonance/#/examples/states-by-age) are a work in progress. Feedback welcome.

[![Build Status](https://travis-ci.org/sghall/resonance.svg?branch=master)](https://travis-ci.org/sghall/resonance)
[![Coverage Status](https://coveralls.io/repos/github/sghall/resonance/badge.svg?branch=master)](https://coveralls.io/github/sghall/resonance?branch=master)
Expand Down

0 comments on commit 8485634

Please sign in to comment.