Skip to content

Commit

Permalink
Merge pull request #63 from jmeas/patch-1
Browse files Browse the repository at this point in the history
Add installation instructions to README
  • Loading branch information
jquense committed May 19, 2017
2 parents 6dc2397 + 186e149 commit 97f5f4b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Expand Up @@ -8,6 +8,18 @@ A ton of thanks to the React team, and contributors for writing and maintaining

The [`TransitionGroup`](#low-level-api-transitiongroup) add-on component is a low-level API for animation, and [`CSSTransitionGroup`](#csstransitiongroup) is an add-on component for easily implementing basic CSS animations and transitions.

## Installation

The recommended installation method is through either [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/en/).

```sh
# npm
npm install react-transition-group --save

# yarn
yarn add react-transition-group
```

## High-level API: CSSTransitionGroup

`CSSTransitionGroup` is a high-level API based on [`TransitionGroup`](#low-level-api-transitiongroup) and is an easy way to perform CSS transitions and animations when a React component enters or leaves the DOM. It's inspired by the excellent [ng-animate](http://www.nganimate.org/) library.
Expand Down

0 comments on commit 97f5f4b

Please sign in to comment.