From 9a41ff84fa1f357d4066329ef7590b549a864622 Mon Sep 17 00:00:00 2001 From: john30 Date: Sat, 4 Feb 2017 13:16:41 +0100 Subject: [PATCH] added docker image, more links --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50887054..0cbafd68 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,14 @@ The main features of the daemon are: * dump received bytes to binary files for later playback/analysis * listen for client connections on a dedicated TCP port (command line style and/or HTTP) * optionally format messages and data in JSON on dedicated HTTP port - * optionally publish all received message data to MQTT topics and vice versa + * optionally publish all received message data to MQTT topics and vice versa including optional TLS + Installation ------------ -Either pick the latest release package suitable for your system -(see https://github.com/john30/ebusd/releases/latest) or build it yourself. +Either pick the [latest release package](https://github.com/john30/ebusd/releases/latest) +suitable for your system or build it yourself. Building ebusd from the source requires the following packages and/or features: * autoconf (>=2.63) + automake (>=1.11) or cmake @@ -65,6 +66,17 @@ Check the Wiki and/or the configuration repository: > https://github.com/john30/ebusd-configuration +Docker image +------------ + +A Docker image is available on the hub and it contains the latest German configuration files. +You can use it like this: +> docker pull john30/ebusd +> docker run -it --rm --device=/dev/ttyUSB0 -p 8888 john30/ebusd + +For more details, see [Docker Readme](contrib/docker/README.md). + + Contact ------- For bugs and missing features use github issue system.