diff options
| author | Christian Pointner <equinox@spreadspace.org> | 2017-06-10 18:00:44 +0200 |
|---|---|---|
| committer | Christian Pointner <equinox@spreadspace.org> | 2017-06-10 18:00:44 +0200 |
| commit | e4bd9f8dff474ec37bbacccec1374a39a929fc00 (patch) | |
| tree | bb4afdd4250bc1ab0aa9f967bfef971c92d276f6 /src/hub/README | |
| parent | add one more TODO (diff) | |
improve documentation and more sanity checks
Diffstat (limited to 'src/hub/README')
| -rw-r--r-- | src/hub/README | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/hub/README b/src/hub/README index 0a17056..38a5ec3 100644 --- a/src/hub/README +++ b/src/hub/README @@ -1,14 +1,13 @@ sfive-hub ========= -`sfive-hub` is a service providing data aggregation, processing, persistence, -filtering and retrieval. +`sfive-hub` is a service providing data aggregation, processing, persistence, and retrieval. -It accepts data via unix domain sockets and REST API, either stores it persistently in -a SQL database or caches it in-memory and queried for data through a REST API. +It accepts data updates via unix domain sockets and REST API, stores it persistently in +a key-value database and can be queried for data through a REST API. It can also forward +the data to a multitude of external analytics tools. Unix domain sockets accept data in the same format as the REST API but are stateful and use the information provided from the init message as specified in [sfive-protocol][]. [sfive-protocol]: git.spreadspace.org/sfive/doc/protocol.md - |