Release v1.0.1

Author: h2zero

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.  
+
+## [1.0.1] - 2020-09-02
+
+### Added
+
+- Empty `NimBLEAddress` constructor: `NimBLEAddress()` produces an address of 00:00:00:00:00:00 type 0.
+- Documentation of the difference of NimBLEAddress::getNative vs the original bluedroid library.
+
+### Changed
+
+- notify_callback typedef is now defined as std::function to enable the use of std::bind to call a class member function.
+
+### Fixed
+
+- Fix advertising start delay when first called.
+
+
+## [1.0.0] - 2020-08-22
+
+First stable release.
+
+All the original library functionality is complete and many extras added with full documentation.

README.md

@@ -1,3 +1,7 @@
+[Latest release ![Release Version](https://img.shields.io/github/release/h2zero/NimBLE-Arduino.svg?style=plastic)
+![Release Date](https://img.shields.io/github/release-date/h2zero/NimBLE-Arduino.svg?style=plastic)](https://github.com/h2zero/NimBLE-Arduino/releases/latest/)  
+<br/>
+
 # NimBLE-Arduino
 A fork of the NimBLE stack restructured for compilation in the Ardruino IDE with a CPP library for use with ESP32.  
 
@@ -32,16 +36,6 @@ Memory after connection: Free Heap: **269792**
 **As shown: there is nearly a 50% reduction in flash use and approx. 100kB less ram consumed!**  
 <br/>
 
-# Development Status
-[Latest release ![Release Version](https://img.shields.io/github/release/h2zero/NimBLE-Arduino.svg?style=plastic) 
-![Release Date](https://img.shields.io/github/release-date/h2zero/NimBLE-Arduino.svg?style=plastic)](https://github.com/h2zero/NimBLE-Arduino/releases/latest/) 
-![Downloads](https://img.shields.io/github/downloads/h2zero/NimBLE-Arduino/latest/total.svg?style=plastic)  
-
-This Library is tracking the esp-nimble repo, nimble-1.2.0-idf master branch, currently [@95bd864.](https://github.com/espressif/esp-nimble)  
-
-Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@2ef4890.](https://github.com/espressif/esp-idf/tree/master/components/bt/host/nimble)  
-<br/>
-
 # Installation
 **Arduino Library manager:** Go to `sketch` -> `Include Library` -> `Manage Libraries` and search for NimBLE and install.  
 
@@ -87,6 +81,11 @@ In `nimconfig.h` the value is:
 Espressif has stated the hard maximum connections is 9.  
 <br/>
 
+# Development Status
+This Library is tracking the esp-nimble repo, nimble-1.2.0-idf master branch, currently [@95bd864.](https://github.com/espressif/esp-nimble)  
+
+Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@2ef4890.](https://github.com/espressif/esp-idf/tree/master/components/bt/host/nimble)  
+<br/>
 
 # Acknowledgments
 * [nkolban](https://github.com/nkolban) and [chegewara](https://github.com/chegewara) for the [original esp32 BLE library](https://github.com/nkolban/esp32-snippets/tree/master/cpp_utils) this project was derived from.
@@ -95,5 +94,8 @@ Espressif has stated the hard maximum connections is 9.
 <br/>  
 
 # Todo
-1. Add Bluetooth Mesh 
+- Improve host reset handler
+- Implement random address handling
+- Implement bond management
+- Add Bluetooth Mesh
 <br/>  

library.properties

@@ -1,9 +1,9 @@
 name=NimBLE-Arduino
-version=1.0.0
-author=H2zero
+version=1.0.1
+author=h2zero
 maintainer=h2zero <[email protected]>
-sentence=BLE library for arduino-esp32 based on NimBLE.
-paragraph=This library is a more updated and lower resource alternative to the original bluedroid library for esp32.
+sentence=Bluetooth low energy (BLE) library for arduino-esp32 based on NimBLE.
+paragraph=This is a more updated and lower resource alternative to the original bluedroid BLE library for esp32. Uses 50% less flash space and approximately 100KB less ram with the same functionality. Nearly 100% compatible with existing application code, migration guide included.
 url=https://github.com/h2zero/NimBLE-Arduino
 category=Communication
 architectures=esp32