UNPKG

react-redux/README.md

Version:

2.51 kBMarkdownView Raw

1React Redux
2=========================
3
4Official React bindings for [Redux](https://github.com/reduxjs/redux).  
5Performant and flexible.
6
7[![build status](https://img.shields.io/travis/reduxjs/react-redux/master.svg?style=flat-square)](https://travis-ci.org/reduxjs/react-redux) [![npm version](https://img.shields.io/npm/v/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)
8[![npm downloads](https://img.shields.io/npm/dm/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)
9[![redux channel on discord](https://img.shields.io/badge/discord-redux@reactiflux-61DAFB.svg?style=flat-square)](http://www.reactiflux.com)
10
11
12## Installation
13
14React Redux requires **React 16.8.3 or later.**
15
16```
17npm install --save react-redux
18```
19
20This assumes that you’re using [npm](http://npmjs.com/) package manager 
21with a module bundler like [Webpack](https://webpack.js.org/) or 
22[Browserify](http://browserify.org/) to consume [CommonJS 
23modules](https://webpack.js.org/api/module-methods/#commonjs).
24
25If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We *don’t* recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/).
26
27## React Native
28
29As of React Native 0.18, React Redux 5.x should work with React Native. If you have any issues with React Redux 5.x on React Native, run `npm ls react` and make sure you don’t have a duplicate React installation in your `node_modules`. We recommend that you use `npm@3.x` which is better at avoiding these kinds of issues.
30
31
32## Documentation
33
34The React Redux docs are now published at **https://react-redux.js.org** .
35
36We're currently expanding and rewriting our docs content - check back soon for more updates!
37
38## How Does It Work?
39
40We do a deep dive on how React Redux works in [this readthesource episode](https://www.youtube.com/watch?v=VJ38wSFbM3A).  
41
42Also, the post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/) 
43explains what it does, how it works, and how the API and implementation have evolved over time.
44
45Enjoy!
46
47## License
48
49[MIT](LICENSE.md)

1	`React Redux`
2	`=========================`
3
4	`Official React bindings for [Redux](https://github.com/reduxjs/redux).`
5	`Performant and flexible.`
6
7	`[![build status](https://img.shields.io/travis/reduxjs/react-redux/master.svg?style=flat-square)](https://travis-ci.org/reduxjs/react-redux) [![npm version](https://img.shields.io/npm/v/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)`
8	`[![npm downloads](https://img.shields.io/npm/dm/react-redux.svg?style=flat-square)](https://www.npmjs.com/package/react-redux)`
9	`[![redux channel on discord](https://img.shields.io/badge/discord-redux@reactiflux-61DAFB.svg?style=flat-square)](http://www.reactiflux.com)`
10
11
12	`## Installation`
13
14	`React Redux requires React 16.8.3 or later.`
15
16	```
17	`npm install --save react-redux`
18	```
19
20	`This assumes that you’re using [npm](http://npmjs.com/) package manager`
21	`with a module bundler like [Webpack](https://webpack.js.org/) or`
22	`[Browserify](http://browserify.org/) to consume [CommonJS`
23	`modules](https://webpack.js.org/api/module-methods/#commonjs).`
24
25	If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We don’t recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/).
26
27	`## React Native`
28
29	As of React Native 0.18, React Redux 5.x should work with React Native. If you have any issues with React Redux 5.x on React Native, run `npm ls react` and make sure you don’t have a duplicate React installation in your `node_modules`. We recommend that you use `npm@3.x` which is better at avoiding these kinds of issues.
30
31
32	`## Documentation`
33
34	`The React Redux docs are now published at https://react-redux.js.org .`
35
36	`We're currently expanding and rewriting our docs content - check back soon for more updates!`
37
38	`## How Does It Work?`
39
40	`We do a deep dive on how React Redux works in [this readthesource episode](https://www.youtube.com/watch?v=VJ38wSFbM3A).`
41
42	`Also, the post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/)`
43	`explains what it does, how it works, and how the API and implementation have evolved over time.`
44
45	`Enjoy!`
46
47	`## License`
48
49	`[MIT](LICENSE.md)`