UNPKG

4.64 kBMarkdownView Raw
1<img title="logo" src="logo/logo-small.gif" width="16.5%">
2<img title="redux-observable" src="logo/logo-text-small.png" width="72%">
3
4[![Join the chat at https://gitter.im/redux-observable/redux-observable](https://badges.gitter.im/redux-observable/redux-observable.svg)](https://gitter.im/redux-observable/redux-observable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5[![build status](https://img.shields.io/travis/redux-observable/redux-observable/master.svg)](https://travis-ci.org/redux-observable/redux-observable)
6[![npm version](https://img.shields.io/npm/v/redux-observable.svg)](https://www.npmjs.com/package/redux-observable)
7[![npm downloads](https://img.shields.io/npm/dm/redux-observable.svg)](https://www.npmjs.com/package/redux-observable)
8[![code climate](https://codeclimate.com/github/redux-observable/redux-observable/badges/gpa.svg)](https://codeclimate.com/github/redux-observable/redux-observable)
9[![Greenkeeper badge](https://badges.greenkeeper.io/redux-observable/redux-observable.svg)](https://greenkeeper.io/)
10
11[RxJS 6](http://github.com/ReactiveX/RxJS)-based middleware for
12[Redux](http://github.com/reactjs/redux). Compose and cancel async actions to create side effects and more.
13
14[https://redux-observable.js.org](https://redux-observable.js.org)
15
16[https://redux-observable-cn.js.org](https://redux-observable-cn.js.org) 中文版(非官方)
17
18# Supporting redux-observable
19
20redux-observable is an independent project with ongoing development and support made possible thanks to donations made by [these awesome backers](BACKERS.md#sponsors) and sponsorship by [This Dot](https://www.thisdot.co/). If you'd like to join them, please consider:
21
22- [Become a backer or sponsor on Patreon](https://www.patreon.com/jayphelps).
23- [One-time donation via PayPal](https://www.paypal.me/jayphelps)
24
25<a href="https://www.patreon.com/bePatron?u=901455" alt="Become a Patron"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" /></a>
26
27# Sponsors
28
29[![This Dot](website/backers/thisdot.svg)](https://www.thisdot.co/labs?utm_source=redux-observable&utm_medium=docs&utm_campaign=v)
30<p align="center"><i>Get support, training, and project consulting by the people who created Redux Observable and RxJS!</i></p>
31
32***
33
34> No Platinum or Gold sponsors yet. [Become one and your name or logo will be here!](https://www.patreon.com/jayphelps) Help keep Open Source sustainable.
35
36## Silver Sponsors ($100+ per month)
37
38- <span style="font-size: 23px; font-weight: bold;">[Kyle Kelley](https://twitter.com/rgbkrk)</span>
39
40## Install
41
42This has peer dependencies of `rxjs@6.x.x` and `redux@4.x.x`, which will have to be installed as well.
43
44```bash
45npm install --save redux-observable
46```
47
48##### UMD
49
50We publish a UMD build inside our npm package. You can use it via the [unpkg](https://unpkg.com/) CDN:
51
52[https://unpkg.com/redux-observable@latest/dist/redux-observable.min.js](https://unpkg.com/redux-observable@latest/dist/redux-observable.min.js)
53
54## Watch an introduction
55
56[![Watch a video on redux-observable](http://img.youtube.com/vi/AslncyG8whg/0.jpg)](https://www.youtube.com/watch?v=AslncyG8whg)
57
58## Online Live Examples
59
60To see redux-observable in action, here's a very simple example to play around with:
61
62* [Using Raw HTML APIs](http://jsbin.com/birogu/edit?js,output)
63* [Using React](http://jsbin.com/jexomi/edit?js,output)
64* [Using Angular v1](http://jsbin.com/laviti/edit?js,output)
65* [Using Angular v2+](https://stackblitz.com/edit/angular-5o3zyo?file=app%2Fapp.component.ts)
66* [Using Ember](https://ember-twiddle.com/093ee4aa271123a84f4eb21f3670b655)
67
68## Documentation
69
70### [https://redux-observable.js.org](https://redux-observable.js.org)
71
72## Discuss
73
74[![Join the chat at https://gitter.im/redux-observable/redux-observable](https://badges.gitter.im/redux-observable/redux-observable.svg)](https://gitter.im/redux-observable/redux-observable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
75
76Everyone is welcome on our [Gitter channel](https://gitter.im/redux-observable/redux-observable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)!
77
78## Custom Emoji
79
80##### Save this:
81
82<img src="https://cloud.githubusercontent.com/assets/762949/18562188/905876f6-7b37-11e6-8677-f9dd091490f6.gif" width="22" height="22" />
83
84Add the redux-observable spinning logo to your Slack channel! [Slack Instructions](https://get.slack.help/hc/en-us/articles/206870177-Create-custom-emoji)
85
86***
87
88*redux-observable is a community-driven, entirely volunteer project and is not officially affiliated with or sponsored by any company.
89
90:shipit: