summaryrefslogtreecommitdiff
path: root/src/hub/README
diff options
context:
space:
mode:
authorMarkus Grüneis <gimpf@gimpf.org>2014-08-24 10:41:52 +0200
committerMarkus Grüneis <gimpf@gimpf.org>2014-09-30 19:10:52 +0200
commit957ced751bea9e35fef4124fae889c60e1a1ff74 (patch)
tree845c716793c3828394a16c02e538f43f747ab751 /src/hub/README
parentadd space to README (diff)
create hub's project structure
Diffstat (limited to 'src/hub/README')
-rw-r--r--src/hub/README10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/hub/README b/src/hub/README
index 13d1128..f69f1cc 100644
--- a/src/hub/README
+++ b/src/hub/README
@@ -1,11 +1,13 @@
-Hub
-===
+sfive-hub
+=========
-A service providing data collection, processing, persistence, filtering and retrieval.
+A service providing data aggregation, processing, persistence, filtering 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.
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 doc/protocol.md
+and use the information provided from the init message as specified in [sfive-protocol][].
+
+[sfive-protocol]: git.spreadspace.org/sfive/doc/protocol.md