diff --git a/README.md b/README.md index 35c706f..98e6b12 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -See the full documentation at [https://jptrsn.github.io/ESP32-mqtt-room/](https://jptrsn.github.io/ESP32-mqtt-room/) +See the pretty documentation at [https://jptrsn.github.io/ESP32-mqtt-room/](https://jptrsn.github.io/ESP32-mqtt-room/) # ESP32-mqtt-room An ESP32 based presence detection node for use with the [Home Assistant](https://www.home-assistant.io/) [`mqtt_room` component](https://www.home-assistant.io/components/sensor.mqtt_room/) for localized device presence detection. +## Release Notes +View the [release notes here](./releaseNotes). + ## Credits This project would not have been possible without the help of a variety of [folks on GitHub and YouTube.](https://jptrsn.github.io/ESP32-mqtt-room/index.html#credits) diff --git a/docs/index.md b/docs/index.md index c4044c6..2bdd580 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,6 +18,7 @@ An ESP32 based presence detection node for use with the [Home Assistant](https:/ 4. [iPhones](#tracking-iphone) 5. [Credits](#credits) 6. [Troubleshooting](#troubleshooting) +7. [Release Notes](#release-notes) ## Requirements @@ -69,3 +70,6 @@ This depends heavily on the hard work done by a number of people. ## Troubleshooting If you're having difficulty getting things set up and work properly, check out [the troubleshooting section](./troubleshooting) before you open an issue. It will help you determine what information you need to provide to identify and fix what's gone wrong. + +## Release Notes +If you're having difficulty updating your device to the newest version, or you're just curious, [check out the release notes.](./releaseNotes) diff --git a/docs/releaseNotes.md b/docs/releaseNotes.md index ba440fe..058ffef 100644 --- a/docs/releaseNotes.md +++ b/docs/releaseNotes.md @@ -1,6 +1,6 @@ # Release Notes -### V0.0.6 +### [V0.0.6](https://github.com/jptrsn/ESP32-mqtt-room/releases/tag/v0.0.6) #### 2019-07-18 - Updated platform `espressif32` to 1.9.0 @@ -25,18 +25,18 @@ upload_flags = ``` Save the file and run the upload command again. Once you've successfully uploaded `v0.0.6` to the device, you'll need to remove this modification, as `v0.0.6` listens on the default port `8266` -### V0.0.5 +### [V0.0.5](https://github.com/jptrsn/ESP32-mqtt-room/releases/tag/v0.0.5) #### 2019-03-19 - Updated ArduinoJSON dependency to version 6. -### V0.0.4 +### [V0.0.4](https://github.com/jptrsn/ESP32-mqtt-room/releases/tag/v0.0.4) #### 2019-02-10 - Added `maxDistance` setting to `config_local.h`. Unit is a non-zero integer in meters. - Fix for AsyncTCP update with breaking changes -### V0.0.3 +### [V0.0.3](https://github.com/jptrsn/ESP32-mqtt-room/releases/tag/v0.0.3) #### 2018-12-10 - Improved stability for the watchdog timer issue. @@ -45,7 +45,7 @@ Save the file and run the upload command again. Once you've successfully uploade - Over-the-Air updates are now possible from the command line of PlatformIO. - On-board LED as status indicator -### V0.0.2 +### [V0.0.1](https://github.com/jptrsn/ESP32-mqtt-room/releases/tag/v0.0.1) #### 2018-12-10 - Improvements to prevent watchdog timeout as in #1. - PlatformIO build and upload support.