UNPKG

recoil/README.md

Version:

1.46 kBMarkdownView Raw

1# Recoil &middot; [![NPM Version](https://img.shields.io/npm/v/recoil)](https://www.npmjs.com/package/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/main/LICENSE) [![Follow on Twitter](https://img.shields.io/twitter/follow/recoiljs?label=Follow%20Recoil&style=social)](https://twitter.com/recoiljs)
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
21Or if you're using [bower](https://cloud.google.com/community/tutorials/install-bower-dependencies-on-google-app-engine):
22
23```shell
24bower install --save recoil
25```
26
27## Contributing
28
29Development 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.
30
31- [Code of Conduct](./CODE_OF_CONDUCT.md)
32- [Contributing Guide](./CONTRIBUTING.md)
33
34### License
35
36Recoil is [MIT licensed](./LICENSE).

1	# Recoil · [![NPM Version](https://img.shields.io/npm/v/recoil)](https://www.npmjs.com/package/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/main/LICENSE) [![Follow on Twitter](https://img.shields.io/twitter/follow/recoiljs?label=Follow%20Recoil&style=social)](https://twitter.com/recoiljs)
2
3	`Recoil is an experimental set of utilities for state management with React.`
4
5	`Please see the website: https://recoiljs.org`
6
7	`## Installation`
8
9	`The Recoil package lives in [npm](https://www.npmjs.com/get-npm). To install the latest stable version, run the following command:`
10
11	```shell
12	`npm install recoil`
13	```
14
15	`Or if you're using [yarn](https://classic.yarnpkg.com/en/docs/install/):`
16
17	```shell
18	`yarn add recoil`
19	```
20
21	`Or if you're using [bower](https://cloud.google.com/community/tutorials/install-bower-dependencies-on-google-app-engine):`
22
23	```shell
24	`bower install --save recoil`
25	```
26
27	`## Contributing`
28
29	`Development 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.`
30
31	`- [Code of Conduct](./CODE_OF_CONDUCT.md)`
32	`- [Contributing Guide](./CONTRIBUTING.md)`
33
34	`### License`
35
36	`Recoil is [MIT licensed](./LICENSE).`