Skip to content

Commit

Permalink
chore(README): Added link to the API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dotansimha authored Oct 31, 2016
1 parent 32413d2 commit 02d6f45
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ Harness Meteor reactivity with RxJS.

RxJS is built to simplify complexity dealing with reactive data flows. At the same time, Meteor's Minimongo cursors are a good target for RxJS API due to their reactivity. Thus, combining RxJS and Meteor, we bring together best parts of two worlds.

# API Documentation

API documentation is available inside this repository, [here](https://github.com/Urigo/meteor-rxjs/tree/master/docs).

## Mongo Cursor Observable
As soon as you install this package (`npm install meteor-rxjs`), you have ability to use a special Mongo collection class that works
with cursor observables instead of the ordinary Mongo cursors. In other words, one can subscribe on the Mongo cursor's data updates now as follows:
Expand Down

0 comments on commit 02d6f45

Please sign in to comment.