From: Philipp Klaus <klaus@physik.uni-frankfurt.de>
Date: Wed, 31 May 2017 09:47:58 +0000 (+0200)
Subject: epics_mqtt_bridge: README added
X-Git-Url: https://jspc29.x-matter.uni-frankfurt.de/git/?a=commitdiff_plain;h=00ae55fe27a782731253463da1924ca6b2047051;p=mvd_epics.git

epics_mqtt_bridge: README added
---

diff --git a/epics_mqtt_bridge/README.md b/epics_mqtt_bridge/README.md
new file mode 100644
index 0000000..a10b17c
--- /dev/null
+++ b/epics_mqtt_bridge/README.md
@@ -0,0 +1,20 @@
+
+### EPICS MQTT Bridge
+
+This software is a bridge from EPICS → MQTT.
+
+It is in the form of a Python package and installs a command line tool, too.
+
+#### Installation
+
+    pip install epics_mqtt_bridge
+
+#### Running the bridge
+
+To start the bridge, create a configuration file and then run:
+
+    epics_mqtt_bridge -c ./your_configuration.ini
+
+The command line argument --help shows all available options and exits.
+
+Stop with `[Ctrl]-[c]`.