From 9d155185a2f26388e7ebad62499a9b25ed5bc8fb Mon Sep 17 00:00:00 2001
From: Gavin Lucas <67045927+GavinLucas@users.noreply.github.com>
Date: Tue, 12 Nov 2024 08:54:23 +0000
Subject: [PATCH] Upddate README.md (#6)

---
 README.md | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 324d687..d262e7e 100644
--- a/README.md
+++ b/README.md
@@ -2,25 +2,30 @@ HueToInflux
 ===========
 
 https://github.com/GavinLucas/HueToInflux
+-----------------------------------------
 
 Script to take data from a Hue Bridge and post it to InfluxDB in order to view the data in Grafana.
 
 Currently, it collects presence, temperature and light readings from Hue Motion Sensors and the brightness 
 of lights, but could be modified to collect other data from the Hue Bridge.
 
-To create a username and pasword for the Hue Bridge, follow the instructions 
+To create a username and password for the Hue Bridge, follow the instructions 
 here: https://developers.meethue.com/develop/get-started-2/
 
 To run the script:
-- copy settings.json.example to settings.json and fill in the values.  The 'sensors' section is for 
-remapping the names of sensors if you're not happy with the names in the Hue settings 
+- copy settings.json.example to settings.json
+  - Change the permissions of the file, e.g. `chmod 600 settings.json`, so that it's not readable 
+  by other users
+  - Fill in the values for your Hue Bridge and InfluxDB
+  - Set the 'interval' to the number of seconds between each data collection
+  - The 'sensors' section is for remapping the names of sensors if you're not happy with the names in the 
+  Hue settings.  This is optional
 - Install the requirements with `pip install -r requirements.txt`
-- Leave it running in a screen session and sit back and watch the data roll in.
+- Leave the script running in a screen session and sit back and watch the data roll in.
 
 There are a couple of options that can be passed to the script to help you understand your data:
 
 - To dump all the data from the Hue Bridge in order to see the names, etc., run `huetoinflux.py --dump` 
 and it will output all the data returned as json.
-
-- To print the data rather than send it to InfluxDB, run `huetoinflux.py --print` and it will output the data 
-structure as json.
+- To print the data rather than send it to InfluxDB, run `huetoinflux.py --print` and it will output the
+parsed data structure as json.