ChangeLog update and doxygen README (#79)

* ChangeLog update and doxygen README

This commit updates our change log for the upcoming release and adds information about doxygen to the README

* Update CHANGELOG for 1.0 release

This commit updates the CHANGELOG with our latest known issues and latest callouts for v1.0 release

Co-authored-by: Matt <[email protected]>

CHANGELOG.md

@@ -4,12 +4,39 @@ All notable changes to the AWS IoT Device Client will be documented in this file
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
-- Resolution for Secure Tunneling SDK 16KB buffering issue. Current Secure Tunneling implementation will
+## [Known Issues]
+- [Device Client aborts on Red Hat Enterprise Linux ARM](https://github.com/awslabs/aws-iot-device-client/issues/87)
+- [Device Client crashes due to SIGSEGV on Ubuntu x86](https://github.com/awslabs/aws-iot-device-client/issues/86)
+- [Device Client crashes on Red Hat Enterprise Linux due to SIGILL](https://github.com/awslabs/aws-iot-device-client/issues/85)
+
+## [1.0.X] - 2021-01-21
+### Added
+- Support for opening multiple tunnels at the same time
+- Handling for secure tunnel OnConnectionShutdown
+- Cross compilation toolchains for a number of platforms
+- Log sanitization to minimize attack surface and protect against printf vulnerabilities
+- Handling for empty json values, local keys and certificates
+- Log messaging to indicate permission information to the user
+- Ownership validation against required files
+- Limitations to log output for Job child processes
+- Exponential backoff retry for initial MQTT connection
+- Recovery mode for Jobs feature to handle duplicate notifications received after connectivity loss
+- Improved logging API startup behavior
+- Support for transferring log queues between logger implementations when configuration changes
+
+### Changed
+- README documentation to provide a better getting started experience
+- String handling in utility functions to reduce risk of string related security vulnerabilities
+- Improved CLI handling for feature enable/disable to maintain parity with .conf JSON file
+- Device Client no longer requires presence of a configuration file as long as required values are provided via CLI
+
+### Removed
+
+### Fixed
+- Secure Tunneling SDK 16KB buffering issue. Previous Secure Tunneling implementation would
 encounter issues if data written to the buffer is larger than 16KB
-- Resolution for Device Defender reboot segfault. There is a known issue where rebooting the device
-while Device Defender is running as a service will trigger a segfault when the Device Client starts again after the reboot
-- Add support for transferring log queues between logger implementations when configuration changes (2021-01-07)
+- Device Defender reboot segfault. There was a known issue where rebooting the device
+  while Device Defender is running as a service would trigger a segfault when the Device Client starts again after the reboot
 
 ## [0.2.X] - 2020-12-23
 ### Added
@@ -39,6 +66,7 @@ while Device Defender is running as a service will trigger a segfault when the D
 
 ## Release Deltas
 
-[Unreleased](https://github.com/awslabs/aws-iot-device-client/compare/v0.2...HEAD)
+[Unreleased](https://github.com/awslabs/aws-iot-device-client/compare/v1.0...HEAD)
+[1.0.X](https://github.com/awslabs/aws-iot-device-client/compare/v0.2...v1.0)
 [0.2.X](https://github.com/awslabs/aws-iot-device-client/compare/v0.0...v0.2)
 [0.0.X](https://github.com/awslabs/aws-iot-device-client/releases/tag/v0.0)

README.md

@@ -853,6 +853,31 @@ If you've decided to add additional logs to the AWS IoT Device Client's source c
 logging API macros can be found in `source/logging/LoggerFactory.h` and typically follow the convention of 
 `LOG_XXXX` for simple log messages and `LOGM_XXXX` for logs that should be formatted with variadic arguments. 
 
+## Documentation
+
+The AWS IoT Device Client project supports the generation of [Doxygen](https://www.doxygen.nl/index.html) documentation.
+To generate the documentation, you'll first need to install Doxygen on your machine. This can be done using Homebrew on Mac
+as follows:
+
+```
+brew install doxygen # https://formulae.brew.sh/formula/doxygen
+```
+
+and on Linux (Ubuntu):
+
+```
+sudo apt-get install doxygen
+```
+
+Once Doxygen is installed on your machine, you can generate the documentation as follows:
+
+```
+cd doc # Navigate into the documentation folder
+doxygen # Doxygen bin generates HTML and Latex output
+```
+
+To view the HTML documentation, you can then navigate into the HTML folder and open `index.html` in your preferred web browser. 
+
 ## Security
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.