Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit c0d8580

Browse files
committed
update readme
1 parent e249124 commit c0d8580

File tree

2 files changed

+15
-21
lines changed

2 files changed

+15
-21
lines changed

‎README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,25 @@ xReact is a Functional Reactive State Wrapper for React Components. Data flow in
1515

1616
## Get Started
1717

18-
xReact works for both TypeScript and CMD JS, to install xReact simply use you yarn or npm:
18+
xReact works for both TypeScript and CMD JS, to install xReact simply use yarn or npm:
1919

2020
```
2121
npm install xreact --save
2222
# or
2323
yarn add xreact
2424
```
2525

26-
- Quick Start :point_right: https://xreact.oyanglul.us/Get-Started.html
27-
- Examples :point_right: https://github.com/reactive-react/xreact/tree/master/examples
2826

29-
## Documentation
27+
- Come from redux? :point_right: <https://xreact.oyanglul.us/Get-Started.html>
28+
- Come from fantasy land? :rainbow: <https://xreact.oyanglul.us/Fantasy.html>
29+
- Examples :point_down:
30+
- <https://github.com/reactive-react/xreact/tree/master/examples>
31+
- <https://xreact.oyanglul.us/Examples.html>
3032

31-
xReact information and documentation is available on [the website](http://xreact.oyanglul.us/).
33+
## Documentation
3234

33-
<!-- We also have a Scaladoc index. -->
35+
All xReact information and documentation is available on [the website](http://xreact.oyanglul.us/).
3436

35-
Finally, we have a list of [frequently-asked questions](https://xreact.oyanglul.us/FAQ.html).
37+
And... we have a list of [frequently-asked questions](https://xreact.oyanglul.us/FAQ.html).
3638

37-
Our goal is to have clear and comprehensive documentation. If you notice problems, omissions, or errors, please [let us know](https://github.com/reactive-react/xreact/issues).
39+
Our goal is to have clear and comprehensive documentation. If you notice problems, omissions, or errors, please [let us know](https://github.com/reactive-react/xreact/issues), or PR is more than welcome.

‎docs/src/main/tut/index.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,23 @@ npm install xreact --save
1919
yarn add xreact
2020
```
2121

22-
A 👉 [quick walk through of a counter app](Get-Started.html) will give you a brief idea of how xReact work.
22+
- Come from redux? :point_right: <https://xreact.oyanglul.us/Get-Started.html>
23+
- Come from fantasy land? :rainbow: <https://xreact.oyanglul.us/Fantasy.html>
24+
- Examples :point_down:
25+
- <https://github.com/reactive-react/xreact/tree/master/examples>
26+
- <https://xreact.oyanglul.us/Examples.html>
2327

2428
## Features
2529

2630
### Purely Functional, Declarative, and Monadic
2731
In imperatively written code, you describe step-by-step how to process data. With `xreact`, we simply define data transformations, then compose them to form our data flow. There are no variables, no intermediate state, and no side effects in your data flow's data composition!
2832

29-
![](https://github.com/fantasyland/fantasy-land/raw/master/logo.png)
30-
31-
There's also [Fantasy Land](https://github.com/fantasyland/fantasy-land) implementation in `src/fantasy.ts`, you can see [bmi calculator example](https://github.com/reactive-react/xreact/blob/master/examples/bmi-calc/app.tsx) to get the idea.
32-
3333
### Typesafe and scalable
3434
xReact is 100% Typescript!, abstract Stream as Higher Kind type so easier to bring new FRP lib to integrete with xreact.
3535

3636
### Composable and Reusable `Plan`
3737
In Redux, reducers' use of `switch` statements can make them difficult to compose. Unlike reducers, the function `x` return is simply a function which can easily compose.
3838

39-
4039
```js
4140
const Counter = x(plan1)(x(plan2)(CounterView))
4241
// is the same as
@@ -53,15 +52,8 @@ Because UI and UI behavior are loosely coupled, you can test a React component b
5352
Asynchronous functions, such as Promises, can be converted to a stream and then flat-mapped.
5453

5554
```js
56-
import {Observable} from '@reactivex/rxjs/Observable'
57-
58-
...
59-
6055
intent$.filter(x=>x.kind=='rest')
6156
.flatMap(({url}) => Observable.fromPromise(fetch(url)))
62-
.map(...)
63-
64-
...
6557
```
6658

6759
where `fetch(url)` will return a `Promise`,

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /