Skip to content
Merged
Changes from all commits
Commits
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
Update README.md
- Added table of contents for easy navigation 
- Added License and Installation sections
  • Loading branch information
ahadc authored Apr 2, 2018
commit d25c9d41f3ff5b8f4fc81faedc84f14f64067566
22 changes: 21 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
[![Build Status](https://travis-ci.org/drcmda/react-spring.svg?branch=master)](https://travis-ci.org/drcmda/react-spring) [![npm version](https://badge.fury.io/js/react-spring.svg)](https://badge.fury.io/js/react-spring)

# Installation 🔧
npm install react-spring

# Table of Contents 🔗
* [Installation](#installation-)
* [Why](#why-)
* [Overview](#overview-)
* [Springs](#springs-demo)
* [Mount/unmount Transitions](#mountunmount-transitions-demo)
* [2-state Reveals](#2-state-reveals-demo)
* [Trails/Staggered animations](#trails-and-staggered-animations-demo)
* [Parallax and page instructions](#parallax-and-page-transitions-demo)
* [API Overview](#api-overview-)
* [Springs and Interpolation](#springs-and-interpolation)
* [Render Props](#render-props)
* [Native rendering](#native-rendering-demo)
* [Transitions](#transitions)
* [Parallax and page transitions](#parallax-and-page-transitions)
* [License](#license-)

# Why 🤔

react-spring is a cooked down fork of Christopher Chedeau's [animated](https://github.com/animatedjs/animated) (which is used in react-native by default). It is trying to bridge it with Cheng Lou's [react-motion](https://github.com/chenglou/react-motion). Although both are similar in that they are spring-physics based, they have their pros and cons and could definitively benefit from one another:
Expand Down Expand Up @@ -217,3 +234,6 @@ import { Parallax } from 'react-spring'
---

[API](https://github.com/drcmda/react-spring/blob/master/API.md) | [Changelog](https://github.com/drcmda/react-spring/blob/master/CHANGELOG.md)

# License ⚖
### [MIT](https://github.com/drcmda/react-spring/blob/master/LICENSE)