From 186e149599c22adf68ab99d8dcd21262ca5fcacd Mon Sep 17 00:00:00 2001 From: "James, please" Date: Fri, 19 May 2017 11:25:48 -0700 Subject: [PATCH] Add installation instructions to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4fb77b04..710376d8 100644 --- a/README.md +++ b/README.md @@ -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.