diff --git a/breaking_changes.md b/breaking_changes.md index a26a0b8..9a8bbeb 100644 --- a/breaking_changes.md +++ b/breaking_changes.md @@ -1,10 +1,6 @@ # Breaking changes -### Upgrading from v2.5.1 to v3.0.0-alpha -This is an informal list of changes, maintained during development, to give a "heads up" on what to expect. +### Upgrading from v2.5.1 to v3.0.0 -The list will grow and change. - -### Just tell me already! * `update()` is gone * update happens automatically after paging @@ -18,4 +14,8 @@ The list will grow and change. * `setFastmode(instance.fastmode.OFF)` - > `fastmodeOff()` * `setFastmode(instance.fastmode.FINALIZING)` - > `fastmodeON()` * `setFastmode(instance.fastmode.ON)` - > `fastmodeTurbo()` - \ No newline at end of file + +* `deepSleep()` replaced with new hardware-focussed methods: + * `usingPowerSwitching(pin, switch_type)` + * `externalPowerOff()` + * `externalPowerOn()` \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 792f113..fc88c4d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,6 +3,8 @@ Third-party Arduino Library for **Heltec E-Ink Module** displays.
Run-time drawing, using Adafruit-GFX. +*v2.x users: see [breaking_changes.md](breaking_changes.md)* + **[Read the API](/docs/API.md)**
- [Supported Platforms](#supported-platforms) diff --git a/library.properties b/library.properties index 63d65fc..5946390 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=heltec-eink-modules -version=3.0.0-alpha +version=3.0.0 author=Todd Herbert maintainer=Todd Herbert sentence=Third party graphics library for Heltec E-Ink modules. -paragraph=AdafruitGFX and paging, to enable Arduino UNO support. +paragraph=AdafruitGFX and Arduino Uno R3 support. category=Display url=https://github.com/todd-herbert/heltec-eink-modules -architectures=avr, esp32 +architectures=avr, esp32, esp8266