Skip to content

Commit ce41b4f

Browse files
committed
fix(docs): updates to readme and badges
1 parent 03bb47b commit ce41b4f

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,41 @@
11
# Entities reducer
22

3+
Redux high order reducer for normalized `flux-standard-action`s
4+
35
[![Build Status][build-badge]][build]
46
[![Code Coverage][coverage-badge]][coverage]
57
[![version][version-badge]][package]
68

79

810
[![Watch on GitHub][github-watch-badge]][github-watch]
911
[![Star on GitHub][github-star-badge]][github-star]
10-
[![Tweet][twitter-badge]][twitter]
1112

1213

13-
-- TODO: Write some docs
14+
Allows for updates to entities in state. Accepts custom reducers to further control.
15+
16+
## Usage
17+
18+
```javascript
19+
import { combineReducers } from 'redux';
20+
import entitiesReducer from 'entities-reducer';
1421

15-
For now read the tests :)
22+
const rootReducer = combineReducers({
23+
entities: entitiesReducer({
24+
/* custom reducers here */
25+
}),
26+
});
1627

28+
export default rootReducer;
29+
```
1730

1831

32+
[build]: https://travis-ci.org/kwelch/entities-reducer
1933
[build-badge]: https://img.shields.io/travis/kwelch/entities-reducer.svg?style=flat-square
2034
[coverage-badge]: https://img.shields.io/codecov/c/github/kwelch/entities-reducer.svg?style=flat-square
35+
[coverage]: https://codecov.io/github/kwelch/entities-reducer
2136
[github-watch-badge]: https://img.shields.io/github/watchers/kwelch/entities-reducer.svg?style=social
37+
[github-watch]: https://github.com/kwelch/entities-reducer/watchers
2238
[github-star-badge]: https://img.shields.io/github/stars/kwelch/entities-reducer.svg?style=social
23-
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kwelch/entities-reducer.svg?style=social
39+
[github-star]: https://github.com/kwelch/entities-reducer/stargazers
2440
[version-badge]: https://img.shields.io/npm/v/entities-reducer.svg?style=flat-square
41+
[package]: https://www.npmjs.com/package/entities-reducer

0 commit comments

Comments
 (0)