aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2023-07-23 16:44:22 +0200
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2023-07-23 16:44:22 +0200
commit619bf5c008f57be5e6d5e88ce214052a10238c18 (patch)
tree099064b010b401a1bcd28657e3338e34131ae3c7
parentd08081ae02ee772b2576872822c702e31c430870 (diff)
Some README
-rw-r--r--README.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 406f785..6a00502 100644
--- a/README.rst
+++ b/README.rst
@@ -2,6 +2,19 @@
kerbana - a data management platform
======================================
+kerbana is a platform that receives data from MQTT, saves it into RRDs
+(Round Robin Databases) and generates and serves user-configured graphs.
+
+It is designed for ease of hosting and packaging inside distributions,
+and it's meant to be especially suitable for small installations with a
+few users. Think environmental monitoring at home, not data monitoring
+inside a datacenter (there are already many other versatile, if complex,
+solutions for that usecase).
+
+The name comes from kerbaną_, cognate of γράφω_
+
+.. _kerbaną: https://en.wiktionary.org/wiki/Reconstruction:Proto-Germanic/kerban%C4%85
+.. _γράφω: https://en.wiktionary.org/wiki/%CE%B3%CF%81%CE%AC%CF%86%CF%89#Ancient_Greek
Installation
------------