Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[chore] update installation documentation. #443

Merged
merged 1 commit into from
Jun 27, 2017
Merged

[chore] update installation documentation. #443

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

We maintain that accessibility is a key component of any modern web application. As such, we have created this modal in such a way that it fulfills the accessibility requirements of the modern web. We seek to keep the focus on accessibility while providing a functional, capable modal component for general use.

## Installation

To install the stable version you can use [npm](https://npmjs.org/) or [yarn](https://yarnpkg.com):


$ npm install react-modal
$ yarn add react-modal


## General Usage

The following is an example of using react-modal specifying all the possible props and options:
Expand Down Expand Up @@ -76,15 +85,6 @@ import ReactModal from 'react-modal';
/>
```

## Install

With [npm](https://npmjs.org/) installed, run

```
$ npm install react-modal
```


## License

MIT