| 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 | [](https://gitter.im/redux-observable/redux-observable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 5 | [](https://travis-ci.org/redux-observable/redux-observable)
|
| 6 | [](https://www.npmjs.com/package/redux-observable)
|
| 7 | [](https://www.npmjs.com/package/redux-observable)
|
| 8 |
|
| 9 | [RxJS](http://github.com/ReactiveX/RxJS)-based middleware for
|
| 10 | [Redux](http://github.com/reactjs/redux). Compose and cancel async actions to create side effects and more.
|
| 11 |
|
| 12 | [https://redux-observable.js.org](https://redux-observable.js.org)
|
| 13 |
|
| 14 | > Note: this project is quite stable, but is currently in maintenance mode. Critical fixes will still be released, but for now no additional features or changes will be considered as the maintainer [@jayphelps](https://github.com/jayphelps) is not actively working on any apps that use redux-observable (or any UI apps at all, actually.) If you would like to become a maintainer, please reach out to [@jayphelps](https://github.com/jayphelps). There is some [ongoing discussion](https://github.com/redux-observable/redux-observable/issues/738) around a potential 2.0.0 release (based on the current alpha) if you'd like to join in.
|
| 15 |
|
| 16 | ## Install
|
| 17 |
|
| 18 | This has peer dependencies of `rxjs@6.x.x` and `redux@4.x.x`, which will have to be installed as well.
|
| 19 |
|
| 20 | ```bash
|
| 21 | npm install --save redux-observable
|
| 22 | ```
|
| 23 |
|
| 24 | > Note: current stable version `redux-observable` doesn't work with `rxjs@7.x.x`, it works with `rxjs@6.x.x`. If you still want to use `rxjs@7.x.x`, upgrade to `redux-observable@2.0.0-rc.2`.
|
| 25 |
|
| 26 | ##### UMD
|
| 27 |
|
| 28 | We publish a UMD build inside our npm package. You can use it via the [unpkg](https://unpkg.com/) CDN:
|
| 29 |
|
| 30 | [https://unpkg.com/redux-observable@latest/dist/redux-observable.min.js](https://unpkg.com/redux-observable@latest/dist/redux-observable.min.js)
|
| 31 |
|
| 32 | ## Watch an introduction
|
| 33 |
|
| 34 | [](https://www.youtube.com/watch?v=AslncyG8whg)
|
| 35 |
|
| 36 | ## Documentation
|
| 37 |
|
| 38 | ### [https://redux-observable.js.org](https://redux-observable.js.org)
|
| 39 |
|
| 40 | ## Discuss
|
| 41 |
|
| 42 | [](https://gitter.im/redux-observable/redux-observable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 43 |
|
| 44 | Everyone 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)!
|
| 45 |
|
| 46 | ## Custom Emoji
|
| 47 |
|
| 48 | ##### Save this:
|
| 49 |
|
| 50 | <img src="https://cloud.githubusercontent.com/assets/762949/18562188/905876f6-7b37-11e6-8677-f9dd091490f6.gif" width="22" height="22" />
|
| 51 |
|
| 52 | Add the redux-observable spinning logo to your Slack channel! [Slack Instructions](https://get.slack.help/hc/en-us/articles/206870177-Create-custom-emoji)
|
| 53 |
|
| 54 | ***
|
| 55 |
|
| 56 | *redux-observable is a community-driven, entirely volunteer project and is not officially affiliated with or sponsored by any company.
|
| 57 |
|
| 58 | :shipit:
|