docs(rstream): update readme

BREAKING CHANGE: document new stream/sub config opts in readme
thi-ng · Nov 30, 2019 · 4ecdbf9 · 4ecdbf9
1 parent 3f7839f
commit 4ecdbf9
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 6 deletions.
diff --git a/packages/rstream/README.md b/packages/rstream/README.md
@@ -12,6 +12,7 @@ This project is part of the
 - [About](#about)
 - [Conceptual differences to RxJS](#conceptual-differences-to-rxjs)
   - [Status](#status)
+  - [Breaking changes in 3.0.0](#breaking-changes-in-3-0-0)
   - [Support packages](#support-packages)
   - [Related packages](#related-packages)
 - [Installation](#installation)
@@ -21,6 +22,7 @@ This project is part of the
   - [Common configuration options](#common-configuration-options)
   - [Stream creation](#stream-creation)
     - [Stream](#stream)
+  - [IDeref support](#ideref-support)
     - [Subscription](#subscription)
     - [Other stream creation helpers](#other-stream-creation-helpers)
   - [Meta streams](#meta-streams)
@@ -99,6 +101,13 @@ programming:
 
 **STABLE** - used in production
 
+### Breaking changes in 3.0.0
+
+The vast majority of stream & subscription constructors and their
+syntax-sugar factory functions have been updated to take their various
+options from a config object arg. Please see [Common configuration
+options](#common-configuration-options) for further details.
+
 ### Support packages
 
 - [@thi.ng/rstream-csp](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-csp) - [@thi.ng/csp](https://github.com/thi-ng/umbrella/tree/master/packages/csp) bridge module for [@thi.ng/rstream](https://github.com/thi-ng/umbrella/tree/master/packages/rstream)
@@ -225,7 +234,9 @@ Interactive grid generator, SVG generation & export, undo/redo support
 
 ### Common configuration options
 
-Since version 3.0.0 all stream and subscription factory functions take an optional object of configuration options with at least these keys (each optional):
+Since version 3.0.0 all stream and subscription factory functions take
+an optional object of configuration options with **at least** these keys
+(each optional):
 
 ```ts
 interface CommonOpts {
@@ -307,7 +318,10 @@ b.next(42);
 // b2 42
 ```
 
-`Stream`s (like `Subscription`s) implement the @thi.ng/api `IDeref`
+### IDeref support
+
+`Stream`s (like `Subscription`s) implement the [@thi.ng/api
+`IDeref`](https://github.com/thi-ng/umbrella/blob/master/packages/api/src/api/deref.ts)
 interface which provides read access to a stream's last received value.
 This is useful for various purposes, e.g. in combination with
 @thi.ng/hdom, which supports direct embedding of streams (i.e. their
@@ -364,7 +378,9 @@ s.next(42);
 
 ### Meta streams
 
-Meta streams are streams of streams. A `MetaStream` is a subscription
+Source: [metaStream()](https://github.com/thi-ng/umbrella/blob/master/packages/rstream/src/metastream.ts)
+
+`MetaStream`s are streams of streams. A `MetaStream` is a subscription
 type which transforms each incoming value into a new stream, subscribes
 to it (via an hidden / internal subscription) and then only passes
 values from that stream to its own subscribers. If a new value is

diff --git a/packages/rstream/README.tpl.md b/packages/rstream/README.tpl.md
@@ -64,6 +64,13 @@ programming:
 
 ${status}
 
+### Breaking changes in 3.0.0
+
+The vast majority of stream & subscription constructors and their
+syntax-sugar factory functions have been updated to take their various
+options from a config object arg. Please see [Common configuration
+options](#common-configuration-options) for further details.
+
 ${supportPackages}
 
 ${relatedPackages}
@@ -88,7 +95,9 @@ ${docLink}
 
 ### Common configuration options
 
-Since version 3.0.0 all stream and subscription factory functions take an optional object of configuration options with at least these keys (each optional):
+Since version 3.0.0 all stream and subscription factory functions take
+an optional object of configuration options with **at least** these keys
+(each optional):
 
 ```ts
 interface CommonOpts {
@@ -170,7 +179,10 @@ b.next(42);
 // b2 42
 ```
 
-`Stream`s (like `Subscription`s) implement the @thi.ng/api `IDeref`
+### IDeref support
+
+`Stream`s (like `Subscription`s) implement the [@thi.ng/api
+`IDeref`](https://github.com/thi-ng/umbrella/blob/master/packages/api/src/api/deref.ts)
 interface which provides read access to a stream's last received value.
 This is useful for various purposes, e.g. in combination with
 @thi.ng/hdom, which supports direct embedding of streams (i.e. their
@@ -227,7 +239,9 @@ s.next(42);
 
 ### Meta streams
 
-Meta streams are streams of streams. A `MetaStream` is a subscription
+Source: [metaStream()](https://github.com/thi-ng/umbrella/blob/master/packages/rstream/src/metastream.ts)
+
+`MetaStream`s are streams of streams. A `MetaStream` is a subscription
 type which transforms each incoming value into a new stream, subscribes
 to it (via an hidden / internal subscription) and then only passes
 values from that stream to its own subscribers. If a new value is