update changelog and README for #17, #23, and #30

ironsheep · Jun 14, 2021 · 62d80d4 · 62d80d4
1 parent fa30d94
commit 62d80d4
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,13 @@
+Sun, 13 Jun 2021 21:13:32 -0600 v1.5.5
+
+ - BUGFIX allow special characters to be used in config.ini (#30)
+ - NEW add CPU Usage reports (#23)
+ - Add alternate install location assistance to README (#17)
+
+Sat Aug 29 17:50:42 2020 -0600 v1.5.4
+
+  - CPU throttle state reporting (#15)
+
 Wed Aug 19 12:33:14 2020 -0600 v1.5.3
 
   - BUGFIX: fixed broken Network IF parser when only one interface (think pizero)

diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ Each RPi device is reported as three topics:
 
 | Name            | Device Class | Units | Description
 |-----------------|-------------|-------------|-------------|
-| `~/monitor`   | 'timestamp' | n/a | Is a timestamp which shows when the RPi last sent information, carries a template payload conveying all monitored values (attach the lovelace custom card to this sensor!)
+| `~/monitor`   | 'timestamp' | n/a | Is a timestamp which shows when the RPi last sent information, carries a template payload conveying all monitored values (**attach the lovelace custom card to this sensor!**)
 | `~/temperature`   | 'temperature' | degrees C | Shows the latest system temperature
 | `~/disk_used`   | none | percent (%) | Shows the amount of root file system used
 
@@ -119,6 +119,13 @@ cd /opt/RPi-Reporter-MQTT2HA-Daemon
 sudo pip3 install -r requirements.txt
 ```
 
+**WARNING:** If you choose to install these files in a location other than `/opt/RPi-Reporter-MQTT2HA-Daemon`, you will need to modify some of the control files which are used when setting up to run this script automatically. The following files:
+
+- **rpi-reporter** - Sys V init script
+- **isp-rpi-reporter.service** - Systemd Daemon / Service description file
+
+... need to have any mention of `/opt/RPi-Reporter-MQTT2HA-Daemon` changed to your install location **before you can run this script as a service.**
+
 ## Configuration
 
 To match personal needs, all operational details can be configured by modifying entries within the file [`config.ini`](config.ini.dist).