UNPKG

1.07 kBMarkdownView Raw
1# Recoil · [![Node.js CI](https://github.com/facebookexperimental/Recoil/workflows/Node.js%20CI/badge.svg)](https://github.com/facebookexperimental/Recoil/actions) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/facebookexperimental/Recoil/blob/master/LICENSE)
2
3Recoil is an experimental set of utilities for state management with React.
4
5Please see the website: https://recoiljs.org
6
7## Installation
8
9The Recoil package lives in [npm](https://www.npmjs.com/get-npm). To install the latest stable version, run the following command:
10
11```shell
12npm install recoil
13```
14
15Or if you're using [yarn](https://classic.yarnpkg.com/en/docs/install/):
16
17```shell
18yarn add recoil
19```
20
21## Contributing
22
23Development of Recoil happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Recoil.
24
25- [Code of Conduct](./CODE_OF_CONDUCT.md)
26- [Contributing Guide](./CONTRIBUTING.md)
27
28### License
29
30Recoil is [MIT licensed](./LICENSE).