Skip to content

Commit 6804bc1

Browse files
committed
Typo fixes, linked Upgrade Guide to README
1 parent c5e66a1 commit 6804bc1

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,17 @@ platformio lib install 562
1212
```
1313

1414
## Credits
15-
This library has initially been written by Daniel Eichhorn (@squix78). Many thanks go to Fabrice Weinberg (@FWeinb) for optimizing and refactoring the UI library. Also many thanks to the many committers who helped add new features and fix bugs.
15+
This library has initially been written by Daniel Eichhorn (@squix78). Many thanks go to Fabrice Weinberg (@FWeinb) for optimizing and refactoring many aspects of the library. Also many thanks to the many committers who helped to add new features and who fixed many bugs.
1616
The init sequence for the SSD1306 was inspired by Adafruit's library for the same display.
1717

1818
## Usage
1919

2020
Check out the examples folder for a few comprehensive demonstrations how to use the library. Also check out the ESP8266 Weather Station library (https://github.com/squix78/esp8266-weather-station) which uses the OLED library to display beautiful weather information.
2121

22+
## Upgrade
23+
24+
The API changed a lot with the 3.0 release. If you were using this library with older versions please have a look at the [Upgrade Guide](UPGRADE-3.0.md).
25+
2226
## Features
2327

2428
* Draw pixels at given coordinates

UPGRADE-3.0.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ version 3.0
99
To get better performance and a smaller font definition format, we change the memory
1010
layout of the font definition format. If you are using custom fonts not included in
1111
this library we updated the font generator [here](http://oleddisplay.squix.ch/#/home).
12-
Please update your fonts to be working with 3.0.
12+
Please update your fonts to be working with 3.0 by selecting the respective version in the dropdown.
1313

1414

1515
## Architectural Changes
@@ -87,7 +87,7 @@ LoadingStage loadingStages[] = {
8787
int LOADING_STAGES_COUNT = sizeof(loadingStages) / sizeof(LoadingStage);
8888
```
8989

90-
After defining your array of `LoadingStages` you can than run the loading process by using
90+
After defining your array of `LoadingStages` you can then run the loading process by using
9191
`ui.runLoadingProcess(loadingStages, LOADING_STAGES_COUNT)`. This will give you a
9292
nice little loading animation you can see in the beginning of [this](https://vimeo.com/168362918)
9393
video.

0 commit comments

Comments
 (0)