From e4bd9f8dff474ec37bbacccec1374a39a929fc00 Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Sat, 10 Jun 2017 18:00:44 +0200 Subject: improve documentation and more sanity checks --- src/hub/README | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'src/hub/README') 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 - -- cgit v1.2.3