From 80a1bc4ddd8f7253bce95a97ea48f3620d6396fe Mon Sep 17 00:00:00 2001
From: Christian Pointner <equinox@spreadspace.org>
Date: Sun, 3 Aug 2014 20:27:14 +0200
Subject: added initial directory structure and some introductionary
 information

---
 src/daq/README | 16 ++++++++++++++++
 src/hub/README | 11 +++++++++++
 src/viz/README |  4 ++++
 3 files changed, 31 insertions(+)
 create mode 100644 src/daq/README
 create mode 100644 src/hub/README
 create mode 100644 src/viz/README

diff --git a/src/daq/README b/src/daq/README
new file mode 100644
index 0000000..299ad16
--- /dev/null
+++ b/src/daq/README
@@ -0,0 +1,16 @@
+Data Acquisition
+================
+
+This directory contains service/technology specific plugins which
+acquire and transform data and push it to the hub.
+
+Currently these plugins use the same protocol as defined doc/protocol.md
+but send those data using unix sockets.
+
+flumotion-plug
+: a plug for http-streamer which gathers live data
+flumotion-rrd
+: a batch import for exisiting rrd data written by flumotion rrd plug
+accesslog
+: a batch or live importer for acceslog-based data (nginx, apache)
+
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
+
diff --git a/src/viz/README b/src/viz/README
new file mode 100644
index 0000000..6e4d40c
--- /dev/null
+++ b/src/viz/README
@@ -0,0 +1,4 @@
+Data Vizualisation
+==================
+
+A single page web application using data form HUB and showing it nicly.
\ No newline at end of file
-- 
cgit v1.2.3