Back to Pretty OTA

lib/PrettyOTA/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+## Upcoming (unreleased, work in progress for next version)
+
+- (WIP) Added FirmwarePull function to PrettyOTA. See README for details
+- Reworked license for clarity
+
+#### Website
+- (Changed JS codestyle to match C++ codestyle)
+- Optimized CSS code
+- New success checkmark symbol with animation and reduced flash usage
+- Added pointer cursor when hovering OTA-Mode drop down menu
+- Footer has glassomorphic design now (glossy transparency)
+- Small UI improvements for an even prettier look
+- Small renamings in code
+
+## Version: 1.1.3
+
+- ⚠️ Deprecated `OverwriteAppVersion()` and `OverwriteAppBuildTimeAndDate()`. Use `SetAppVersion()` and `SetAppBuildTimeAndDate()` instead. The deprecated functions will be removed in a future release
+- Added `IsUpdateRunning()` method
+- Removed duplicate strings in default callbacks
+- Changed default hardwareID to `ARDUINO_BOARD` symbol
+- Added compile switch to disable ArduinoOTA functionality: `#define PRETTY_OTA_ENABLE_ARDUINO_OTA 1`. Set it to zero to disable ArduinoOTA and only use the web interface
+- Added a new python script for compressing the HTML file and convert it to the C++ array. See the new `website_compressor` directory
+
+## Version: 1.1.2
+
+- Removed printing of ANSI escape codes in log functions
+- Reduced used stack size by 1KB
+
+## Version: 1.1.1
+
+- Fixed filesystem update issue (partition not found error)
+
+## Version: 1.1.0
+
+- Added HardwareID which can be set using `SetHardwareID(const char* const)`
+- Truncate too long values with ellipsis
+- Showing full (possibly truncated) text on hover for each entry. If for example the HardwareID would be too long to display and gets truncated, you can see the full value when hovering over it
+- Added parameter `printWithColor` to `UseDefaultCallbacks(bool printWithColor = false);` because ArduinoIDE's serial monitor doesn't support color formatted printing with ANSI escape codes
+- Changed license
+
+## Version: 1.0.5 and 1.0.6
+
+- Updated README with better documentation
+- Added donation option
+
+## Version: 1.0.4
+
+- Fixed a bug where long strings for app version, build time and date would break the website formatting
+
+## Version: 1.0.3
+
+- Updated keywords.txt for ArduinoIDE
+- Finished README
+- Fixed README header logo
+- Fixed README TOC for PlatformIO
+
+## Version: 1.0.2
+
+- Fixed PlatformIO release
+
+## Version: 1.0.1
+
+- Added `PRETTY_OTA_SET_CURRENT_BUILD_TIME_AND_DATE` macro, `OverwriteAppBuildTimeAndDate(...)` and `OverwriteAppVersion(...)` to overwrite the build time, build date and app version which get displayed on the website. This is needed when using the ArduinoIDE. See README for details
+- Added mDNS example
+- Added setCustomVersionAndBuildTime example
+- Fixed examples
+- Fixed dependencies for ArduinoIDE
+- Updated README
+
+## Version: 1.0.0
+
+- Backend rewrite and code cleanup for performance optimization
+- Reduced code size
+- UI improvements and cleanup
+- Support for custom URLs (ability to change the default `/update` and `/login` URLs)
+- Renamed internal URLs to avoid name conflicts
+- Added a "Log out" button to website
+- Save and restore logged in clients to NVS automatically. Clients will stay logged in even after a reboot or update of the ESP32
+- Removed dependency on Arduino MD5Builder
+- Added compile checks for incompatible libraries/boards
+- Wrote own low level ESP update manager and removed Arduino dependency
+- Switched to `std::string` instead of Arduino `String`
+- Fixed a bug where every unauthenticated request would get redirected to the login page, even for POST requests
+- Many more changes for usability and performance
+
+## Version 0.3.8
+
+- Initial release