entities-reducer - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

@@ -11,3 +11,3 @@ {
   },
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Redux normalized entity reducer",
@@ -14,0 +14,0 @@ "main": "dist/index.js",

README.md

 # Entities reducer
 
+Redux high order reducer for normalized `flux-standard-action`s  
+
 [![Build Status][build-badge]][build]
@@ -10,16 +12,31 @@ [![Code Coverage][coverage-badge]][coverage]
 [![Star on GitHub][github-star-badge]][github-star]
-[![Tweet][twitter-badge]][twitter]
 
 
--- TODO: Write some docs
+Allows for updates to entities in state. Accepts custom reducers to further control.
 
-For now read the tests :)
+## Usage
 
+```javascript
+import { combineReducers } from 'redux';
+import entitiesReducer from 'entities-reducer';
 
+const rootReducer = combineReducers({
+  entities: entitiesReducer({
+    /* custom reducers here */
+  }),
+});
 
+export default rootReducer;
+```
+
+
+[build]: https://travis-ci.org/kwelch/entities-reducer
 [build-badge]: https://img.shields.io/travis/kwelch/entities-reducer.svg?style=flat-square
 [coverage-badge]: https://img.shields.io/codecov/c/github/kwelch/entities-reducer.svg?style=flat-square
+[coverage]: https://codecov.io/github/kwelch/entities-reducer
 [github-watch-badge]: https://img.shields.io/github/watchers/kwelch/entities-reducer.svg?style=social
+[github-watch]: https://github.com/kwelch/entities-reducer/watchers
 [github-star-badge]: https://img.shields.io/github/stars/kwelch/entities-reducer.svg?style=social
-[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kwelch/entities-reducer.svg?style=social
+[github-star]: https://github.com/kwelch/entities-reducer/stargazers
 [version-badge]: https://img.shields.io/npm/v/entities-reducer.svg?style=flat-square
+[package]: https://www.npmjs.com/package/entities-reducer

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5211

increased by11.16%

Number of lines in readme file

42

increased by68%

No dependency changes