updated readme

Author: ebisso

.gitignore

@@ -144,10 +144,6 @@ cython_debug/
 
 ### VisualStudioCode ###
 .vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
 *.code-workspace
 
 # Local History for Visual Studio Code
@@ -159,4 +155,3 @@ cython_debug/
 .ionide
 
 # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python
-.vscode/settings.json

README.md

@@ -1,9 +1,12 @@
-Paradox Spectra 1738 Serial to Home Assistant MQTT Integration
+# Paradox Spectra 1738 Serial to MQTT
 
 This Python script was made to run on Raspberry Pi B+ connected to the serial port of the Paradox Spectra 1738 alarm panel.
 
-Usage:
-
-docker build -t paradox .
-
-docker run -d --network host --device /dev/ttyAMA0:/dev/ttyAMA0 --restart always paradox
+## Running with docker
+* Set the IP address or hostname of your MQTT broker in the file config.yaml
+* Build the image  
+`docker build -t paradox2mqtt .`
+* Run the container  
+`docker run -d --device /dev/ttyAMA0:/dev/ttyAMA0 --restart=unless-stopped paradox2mqtt`  
+  
+config.yaml can be mounted to /usr/src/app/config.yaml at the run command (`-v $(pwd)/config.yaml:/usr/src/app/config.yaml`) to apply a modified configuration without rebuilding the image.

paradox2mqtt.py

@@ -133,4 +133,4 @@ def main():
 
 
 if __name__ == '__main__':
-    main()
+    main()

requirements.txt

@@ -1,3 +1,3 @@
 pyyaml==5.4
 pyserial==3.5
-paho-mqtt==1.5
+paho-mqtt==1.5