docs: update various readmes

thi-ng · Apr 24, 2018 · 97a6e94 · 97a6e94
1 parent 781ae21
commit 97a6e94
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 1 deletion.
diff --git a/packages/cache/README.md b/packages/cache/README.md
@@ -2,6 +2,9 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/cache.svg)](https://www.npmjs.com/package/@thi.ng/cache)
 
+This project is part of the
+[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
+
 ## About
 
 In-memory cache implementations with different [eviction

diff --git a/packages/heaps/README.md b/packages/heaps/README.md
@@ -2,6 +2,9 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/heaps.svg)](https://www.npmjs.com/package/@thi.ng/heaps)
 
+This project is part of the
+[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
+
 ## About
 
 Type agnostic binary heap & d-ary heap implementations with customizable

diff --git a/packages/rstream-dot/README.md b/packages/rstream-dot/README.md
@@ -2,6 +2,9 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/rstream-dot.svg)](https://www.npmjs.com/package/@thi.ng/rstream-dot)
 
+This project is part of the
+[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
+
 ## About
 
 Graphviz DOT conversion of @thi.ng/rstream dataflow graph topologies.

diff --git a/packages/rstream-gestures/README.md b/packages/rstream-gestures/README.md
@@ -2,6 +2,9 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/rstream-gestures.svg)](https://www.npmjs.com/package/@thi.ng/rstream-gestures)
 
+This project is part of the
+[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
+
 ## About
 
 Unified mouse, mouse wheel & single-touch event stream abstraction.

diff --git a/packages/rstream-query/README.md b/packages/rstream-query/README.md
@@ -2,9 +2,29 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/rstream-query.svg)](https://www.npmjs.com/package/@thi.ng/rstream-query)
 
+This project is part of the
+[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
+
 ## About
 
-TODO...
+@thi.ng/rstream based [triple
+store](https://en.wikipedia.org/wiki/Triplestore) & reactive query
+engine with high re-use ratio of sub-query results. Inserted
+facts/triples are broadcast to multiple indexing streams and query
+subscriptions attached to them. This enables push-based, auto-updating
+query results, which are only changing if upstream transformations &
+filters have been triggered.
+
+Unlike with traditional RDF triple stores, any JS data types can be used
+as subject, predicate or object (though support for such must be
+explicitly enabled).
+
+### Status
+
+This project is currently in pre-ALPHA and intended as a continuation of
+the Clojure based [thi.ng/fabric](http://thi.ng/fabric) project, this
+time built on the streaming primitives provided by
+[@thi.ng/rstream](https://github.com/thi-ng/umbrella/tree/master/packages/rstream).
 
 ## Installation
 
@@ -16,6 +36,8 @@ yarn add @thi.ng/rstream-query
 
 ```typescript
 import * as rstream-query from "@thi.ng/rstream-query";
+
+
 ```
 
 ## Authors

diff --git a/packages/rstream/README.md b/packages/rstream/README.md
@@ -71,9 +71,11 @@ are provided too:
 ## Supporting packages
 
 - [@thi.ng/rstream-csp](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-csp) - CSP channel-to-stream adapter
+- [@thi.ng/rstream-dot](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-dot) - GraphViz DOT conversion of rstream dataflow graph topologies
 - [@thi.ng/rstream-gestures](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-gestures) - unified mouse, single-touch & wheel event stream
 - [@thi.ng/rstream-graph](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-graph) - declarative dataflow graph construction
 - [@thi.ng/rstream-log](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-log) - extensible multi-level, multi-target structured logging
+- [@thi.ng/rstream-query](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-query) - triple store & reactive query engine
 
 ## Conceptual differences to RxJS