Skip to content

Commit

Permalink
chore: breaking_changes.md; increment version
Browse files Browse the repository at this point in the history
  • Loading branch information
todd-herbert committed Sep 12, 2023
1 parent a8f817d commit 4b3c7ba
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
12 changes: 6 additions & 6 deletions breaking_changes.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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()`
</nobr>
</nobr>
* `deepSleep()` replaced with new hardware-focussed methods:
* `usingPowerSwitching(pin, switch_type)`
* `externalPowerOff()`
* `externalPowerOn()`
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Third-party Arduino Library for **Heltec E-Ink Module** displays.<br />
Run-time drawing, using Adafruit-GFX.

*v2.x users: see [breaking_changes.md](breaking_changes.md)*

**[Read the API](/docs/API.md)** <br />

- [Supported Platforms](#supported-platforms)
Expand Down
6 changes: 3 additions & 3 deletions library.properties
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 4b3c7ba

Please sign in to comment.