Document installation/usage

The-Silverwood-Institute · Mar 31, 2020 · 72de9db · 72de9db
1 parent 7744438
commit 72de9db
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,18 @@
 
 Consumes messages from an MQTT topic and sends them to [Localwood's API](https://github.com/The-Silverwood-Institute/Localwood). You would use this microservice in conjunction with an MQTT broker such as [Flespi](https://flespi.com/) to control the lights in your home remotely.
 
+## Requirements
+
+- Python 3
+- paho-mqtt `pip3 install -r requirements.txt`
+
+## Usage
+
+You will need multiple environment variables (see code) to configure the connection to an MQTT broker and to authenticate with Localwood.
+
+1. Run server with: `python3 adorable_qtpi.py`
+2. Run Localwood on the same host
+
 ## Problems?
 
 If you have problems or questions feel free to [open an issue](https://github.com/The-Silverwood-Institute/Localwood/issues/new). Pull requests always welcome :smile_cat:
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+paho-mqtt>=1.5
+requests>=2.23