Browse Source

README "main functionality" plus "helpers" section.

Herbert Vojčík 7 years ago
parent
commit
243ff792a5
1 changed files with 6 additions and 4 deletions
  1. 6 4
      README.md

+ 6 - 4
README.md

@@ -1,8 +1,8 @@
 # redux-sac
 # redux-sac
 
 
-Slice and compose redux-type reducers.
+## Slice and compose redux-type reducers.
 
 
-## `subReducer(key, reducer, additionalKey, ...)`
+### `subReducer(key, reducer, additionalKey, ...)`
 
 
 Creates a wrapper reducer that call `reducer`
 Creates a wrapper reducer that call `reducer`
 on the substate specified by `key`.
 on the substate specified by `key`.
@@ -43,7 +43,7 @@ will be fetched and passed to a sub-reducer:
 
 
 This technique is mentioned in Redux docs, in "Beyond combineReducers" page.
 This technique is mentioned in Redux docs, in "Beyond combineReducers" page.
 
 
-## `composeReducers(reducer1, reducer2, ...)`
+### `composeReducers(reducer1, reducer2, ...)`
 
 
 Creates a wrapper reducer that calls passed reducers
 Creates a wrapper reducer that calls passed reducers
 one after another, passing intermediate states.
 one after another, passing intermediate states.
@@ -60,7 +60,9 @@ Useful to "concatenate" a few `subReducer`s. like:
 	)
 	)
 ```
 ```
 
 
-## `cowValueModel(key, ...)`
+## Redux helpers
+
+### `cowValueModel(key, ...)`
 
 
 Creates an object with set of functions allowing
 Creates an object with set of functions allowing
 to set or get specified key from any object.
 to set or get specified key from any object.