Skip to content

Commit 71365ee

Browse files
committed
readme
1 parent 64377ae commit 71365ee

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ ImmutableJS helpers for use with [Redux Loop](https://redux-loop.js.org/)
44

55
## Installation
66

7-
Redux Loop Immutable requires redux-loop 4.1.0 or higher
7+
The latest Redux Loop Immutable requires the latest redux-loop version. If you need to support an older version of redux-loop, use an older version of redux-loop-immutable.
88

99
```
10-
npm install --save redux-loop-immutable
10+
yarn add redux-loop-immutable
1111
```
1212

1313
## API
@@ -35,6 +35,8 @@ export default combineReducers({
3535

3636
### `mergeChildReducers(parentResult, action, childMap)`
3737

38+
NOTE: `mergeChildReducers` is deprecated as of version 2.0.0. It will be removed in 3.0.0. `combineReducers` and `reduceReducers` (which needs no immutable helper) should cover the cases where `mergeChildReducers` is needed. If you need to use it temporarily without a console warning, use `DEPRECATED_mergeChildReducers(parentResult, action, childMap)`. This will also be removed in 3.0.0 though.
39+
3840
This is an ImmutableJS-optimized version of the `mergeChildRedcuers` provided by core redux-loop.
3941
Like that version of `mergeChildReducers`, it is a more generalized version of `combineReducers` that allows
4042
you to nest reducers underneath a common parent that has functionality of its own (rather than restricting the parent to simply passing actions to its children like `combineReducers` does)

0 commit comments

Comments
 (0)