summaryrefslogtreecommitdiff
path: root/src/hub/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/hub/README')
-rw-r--r--src/hub/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/hub/README b/src/hub/README
new file mode 100644
index 0000000..13d1128
--- /dev/null
+++ b/src/hub/README
@@ -0,0 +1,11 @@
+Hub
+===
+
+A service providing data collection, 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
+