From cd14358420e18227cbf4c6fc4586f99576553b25 Mon Sep 17 00:00:00 2001 From: fb Date: Wed, 9 Nov 2016 14:01:45 +0100 Subject: [PATCH] move streaming sdk to Setup in Readme --- README.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bba374f9..5b8549d7 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,28 @@ You can also include it from our CDN-Provider `fastly`. The Baqend SDK provides a global `DB` variable by default. + +Baqend Streaming SDK +-------------------- + +If you want to use the realtime streaming queries, you have to either use `baqend-streaming.js` or +`baqend-streaming.min.js` for production. + +In Addition, you can include [Rx.js](https://github.com/ReactiveX/rxjs) v5 into your project, for many advanced +Observable features. +You can use the unpkg CDN: + +```html + + + +``` + +The SDK is shipped with the core-js Observable shim per default. +If you include Rx.js globally, it will be detected and used by the SDK automatically. +You can also set the Observable implementation which the SDK will use, +by setting the `require('baqend/streaming').Observable = Observable` afterwards. + Initialize ---------- @@ -60,26 +82,6 @@ DB.ready(function() { ``` -Baqend Streaming SDK - -If you want to use the realtime streaming queries, you have to either use `baqend-streaming.js` or -`baqend-streaming.min.js` for production. - -In Addition, you can include [Rx.js](https://github.com/ReactiveX/rxjs) v5 into your project, for many advanced -Observable features. -You can use the unpkg CDN: - -```html - - - -``` - -The SDK is shipped with the core-js Observable shim per default. -If you include Rx.js globally, it will be detected and used by the SDK automatically. -You can also set the Observable implementation which the SDK will use, -by setting the `require('baqend/streaming').Observable = Observable` afterwards. - Usage in Node.js ----------------