From 4497c3278a7c6e9b45b0016e3ce603d188e5f285 Mon Sep 17 00:00:00 2001 From: Evan Richardson Date: Mon, 3 Sep 2018 00:13:20 -0700 Subject: [PATCH] Update README.md Formatting --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f2f5537..8ab3e21 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,22 @@ Python based Docker for Eagle to MQTT reader I have only ported this into a dockerfile, All Original code (with one minor modification for XML root tag) is credit to -Original Readme as follows from creator, Ted Drain. You can view the original repo this is based on here: https://github.com/TD22057/T-Home - You can run this with the following: ``` docker run --name py-eagle-mqtt -d -e "MQTT_BROKER_IP=" -e "MQTT_BROKER_PORT=" evanrich/py-eagle/mqtt ``` -MQTT_BROKER_IP = your broker's IP address. Defaults to 192.168.1.20 (my local k8s node) -MQTT_BROKER_PORT = your broker's port #. Defaults to 1883 (used in my k8s) +**MQTT_BROKER_IP** = your broker's IP address. Defaults to 192.168.1.20 (my local k8s node) + +**MQTT_BROKER_PORT** = your broker's port #. Defaults to 1883 (used in my k8s) Optionally, you can add the following: -"KEEPALVE=" Sets the keepalive for MQTT, defaults to 60 seconds if not specificed -"MQTT_USER=" Sets the MQTT user, if using authentication. Defaults to "None". Don't specify if not using authentication. -"MQTT_PASS=" Sets the MQTT pasword if using authentication. Defaults to "None". Don't specify if not using authentication. +**"KEEPALVE="** Sets the keepalive for MQTT, defaults to 60 seconds if not specificed + +**"MQTT_USER="** Sets the MQTT user, if using authentication. Defaults to "None". Don't specify if not using authentication. + +**"MQTT_PASS="** Sets the MQTT pasword if using authentication. Defaults to "None". Don't specify if not using authentication. snippet from my MQTT Broker showing container connecting and dissconnecting when I start/stop it: @@ -27,6 +28,17 @@ snippet from my MQTT Broker showing container connecting and dissconnecting when {"pid":1,"hostname":"mqtt-867c776494-6rc57","name":"mosca","level":30,"time":1535955905640,"msg":"closed","client":"","v":1} ``` +## Contributing + +1. Fork it! +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request :D + +Original Readme as follows from creator, Ted Drain. You can view the original repo this is based on here: https://github.com/TD22057/T-Home +--- + T-Home Automation Software ==========================