ReadMe adapted.

kmplngj · May 11, 2014 · e339511 · e339511
1 parent 3cc04bf
commit e339511
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 2 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,7 @@
+2014-05-11 Roland Jax <[email protected]>
+
+ * Beta-Test.
+
 2014-01-09 Roland Jax <[email protected]>
 
  * Initial commit.
diff --git a/NEWS b/NEWS
@@ -0,0 +1,3 @@
+2014-05-11 Roland Jax <[email protected]>
+
+ * Beta-Test.
diff --git a/README b/README
@@ -1,4 +1,38 @@
-ebusd
+ebus-daemon
+-----------
+
+The ebus-daemon provides a communication interface to the energy bus (ebus)
+which is used in various heating systems.
+
+
+Features
+--------
+
+ * send and receive ebus commands
+ - message types: Broadcast, Master-Master and Master-Slave
+ - collect data of cycle messages
+
+ * tcp socket multi session server (daemon commands)
+ - get fetch data from ebus participant
+ - set adjust data of ebus participant
+ - cyc fetch data from collected cycle messages
+ - log change loglevel
+ - dump toggle dump on/off
+ - quit close connection
+
+
+Build
 -----
 
-Daemon to communicate with ebus based heating systems.
+$ ./autogen.sh [--prefix=/usr]
+$ make
+$ make install
+
+
+Daemon Configuration
+--------------------
+
+See ./ebus-daemon -h
+
+
+The author can be contacted at [email protected].