Skip to content

Commit af4cf04

Browse files
committed
update readme
1 parent 467e80d commit af4cf04

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,15 @@ A Monadic Reactive State Container for React Components
99
npm install react-most --save
1010
```
1111

12-
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
12+
<!-- TOC depthFrom:1 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 -->
1313

1414
- [React Most](#react-most)
1515
- [What](#what)
1616
- [Why not (just using existing state container e.g.) redux](#why-not-just-using-existing-state-container-eg-redux)
1717
- [Why indeed?](#why-indeed)
18-
- [Pure Functional, Declarative & Monadic](#pure-functional-declarative-monadic)
19-
- [Composable and Reusable Sinks](#composable-and-reusable-sinks)
20-
- [Transducers support](#transducers-support)
21-
- [Time Travel](#time-travel)
22-
- [Modular and Easy to Extend](#modular-and-easy-to-extend)
2318
- [How](#how)
24-
- [1. Component Wrapper](#1-component-wrapper)
25-
- [2. Define How to connect Component and Streams](#2-define-how-to-connect-component-and-streams)
26-
- [2.1. transform intent stream to state mapper stream](#21-transform-intent-stream-to-state-mapper-stream)
27-
- [2.2. define action mapper that can be use to added intent to your Intent Stream.](#22-define-action-mapper-that-can-be-use-to-added-intent-to-your-intent-stream)
28-
- [3. Use the actions](#3-use-the-actions)
29-
- [[More Examples](./examples)](#more-examplesexamples)
19+
- [[API](https://github.com/jcouyang/react-most/wiki/API)](#apihttpsgithubcomjcouyangreact-mostwikiapi)
20+
- [[More Examples](./examples)](#more-examplesexamples)
3021
- [Performance](#performance)
3122
- [Thanks to...](#thanks-to)
3223

@@ -174,9 +165,13 @@ like redux, but much simpler, when you wrap your App, your App get a `actions` p
174165
onClick={()=>this.props.actions.add(1)} />
175166
```
176167
177-
### [More Examples](./examples)
168+
## [API](https://github.com/jcouyang/react-most/wiki/API)
169+
170+
## [More Examples](./examples)
178171
- [Type N Search](./examples/type-n-search) [(live)](https://oyanglul.us/react-most/examples/type-n-search/public/)
179172
- [TodoMVC](./examples/todomvc) [(live)](https://oyanglul.us/react-most/examples/todomvc/public/)
173+
- [Type N Search with Transducers](./examples/transducer-type-n-search) [(live)](https://oyanglul.us/react-most/examples/transducer-type-n-search/public/)
174+
- [Type N Search with Time Travel](./examples/type-n-search-with-undo) [(live)](https://oyanglul.us/react-most/examples/type-n-search-with-undo/public/)
180175
181176
## Performance
182177
`react-most` no more than creating stream from your actions, and bind it to state stream. no any other computations happen in `react-most`. so please refer to [most.js's perf](https://github.com/cujojs/most/tree/master/test/perf) which is realy Great!

0 commit comments

Comments
 (0)