Skip to content

Commit 41e6fe6

Browse files
authored
Merge pull request pmndrs#6 from ahadc/patch-1
Update README.md
2 parents 108d60e + d25c9d4 commit 41e6fe6

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

readme.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
11
[![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)
2-
2+
# Installation 🔧
33
npm install react-spring
44

5+
# Table of Contents 🔗
6+
* [Installation](#installation-)
7+
* [Why](#why-)
8+
* [Overview](#overview-)
9+
* [Springs](#springs-demo)
10+
* [Mount/unmount Transitions](#mountunmount-transitions-demo)
11+
* [2-state Reveals](#2-state-reveals-demo)
12+
* [Trails/Staggered animations](#trails-and-staggered-animations-demo)
13+
* [Parallax and page instructions](#parallax-and-page-transitions-demo)
14+
* [API Overview](#api-overview-)
15+
* [Springs and Interpolation](#springs-and-interpolation)
16+
* [Render Props](#render-props)
17+
* [Native rendering](#native-rendering-demo)
18+
* [Transitions](#transitions)
19+
* [Parallax and page transitions](#parallax-and-page-transitions)
20+
* [License](#license-)
21+
522
# Why 🤔
623

724
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:
@@ -217,3 +234,6 @@ import { Parallax } from 'react-spring'
217234
---
218235

219236
[API](https://github.com/drcmda/react-spring/blob/master/API.md)[Changelog](https://github.com/drcmda/react-spring/blob/master/CHANGELOG.md)
237+
238+
# License ⚖
239+
### [MIT](https://github.com/drcmda/react-spring/blob/master/LICENSE)

0 commit comments

Comments
 (0)