Update updater script addressing quirks (#461)

homieiot · Dec 26, 2017 · 63fb96d · 63fb96d
1 parent cd3c6e7
commit 63fb96d
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/scripts/ota_updater/README.md b/scripts/ota_updater/README.md
@@ -1,16 +1,15 @@
 Script: OTA updater
 ===================
 
-This will allow you to send an OTA update to your device.
+This script will allow you to send an OTA update to your device.
 
 ## Installation
 
 `pip install -r requirements.txt`
 
 ## Usage
 
-```bash
-> scripts/ota_updater/ota_updater.py -h
+```text
 usage: ota_updater.py [-h] -l BROKER_HOST -p BROKER_PORT [-u BROKER_USERNAME]
                       [-d BROKER_PASSWORD] [-t BASE_TOPIC] -i DEVICE_ID
                       firmware
@@ -39,4 +38,11 @@ arguments:
 
 * `BROKER_HOST` and `BROKER_PORT` defaults to 127.0.0.1 and 1883 respectively if not set.
 * `BROKER_USERNAME` and `BROKER_PASSWORD` are optional.
-* `BASE_TOPIC` defaults to `homie/` if not set
+* `BASE_TOPIC` has to end with a slash, defaults to `homie/` if not set.
+
+### Example:
+
+```bash
+python ota_updater.py -l localhost -u admin -d secure -t "homie/" -i "device-id" /path/to/firmware.bin
+```
+