Skip to content

Commit e1b6530

Browse files
committed
Add README for the npm package
Fix #242.
1 parent a37c0ef commit e1b6530

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

npm-package/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Redux DevTools Extension's helper
2+
3+
[![Join the chat at https://gitter.im/zalmoxisus/redux-devtools-extension](https://badges.gitter.im/zalmoxisus/redux-devtools-extension.svg)](https://gitter.im/zalmoxisus/redux-devtools-extension?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
5+
## Usage
6+
7+
Install:
8+
```
9+
npm install --save redux-devtools-extension
10+
```
11+
and use like that:
12+
```js
13+
import { createStore, applyMiddleware } from 'redux';
14+
import { composeWithDevTools } from 'redux-devtools-extension';
15+
16+
const store = createStore(reducer, composeWithDevTools(
17+
applyMiddleware(...middleware),
18+
// other store enhancers if any
19+
));
20+
```
21+
or if needed to apply [extension’s options](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md#windowdevtoolsextensionconfig):
22+
```js
23+
import { createStore, applyMiddleware } from 'redux';
24+
import { composeWithDevTools } from 'redux-devtools-extension';
25+
26+
const composeEnhancers = composeWithDevTools({
27+
// Specify here name, actionsBlacklist, actionsCreators and other options
28+
});
29+
const store = createStore(reducer, composeEnhancers(
30+
applyMiddleware(...middleware),
31+
// other store enhancers if any
32+
));
33+
```
34+
There’re just [few lines of code](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/npm-package/index.js). If you don’t want to allow the extension in production, just use ‘redux-devtools-extension/developmentOnly’ instead of ‘redux-devtools-extension’.
35+
36+
## License
37+
38+
MIT

0 commit comments

Comments
 (0)