diff --git a/README.md b/README.md index 156c648..d5541e3 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,17 @@ platformio lib install 562 ``` ## Credits -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. +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. The init sequence for the SSD1306 was inspired by Adafruit's library for the same display. ## Usage 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. +## Upgrade + +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). + ## Features * Draw pixels at given coordinates diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md index 69bdd57..e7a315b 100644 --- a/UPGRADE-3.0.md +++ b/UPGRADE-3.0.md @@ -9,7 +9,7 @@ version 3.0 To get better performance and a smaller font definition format, we change the memory layout of the font definition format. If you are using custom fonts not included in this library we updated the font generator [here](http://oleddisplay.squix.ch/#/home). -Please update your fonts to be working with 3.0. +Please update your fonts to be working with 3.0 by selecting the respective version in the dropdown. ## Architectural Changes @@ -87,7 +87,7 @@ LoadingStage loadingStages[] = { int LOADING_STAGES_COUNT = sizeof(loadingStages) / sizeof(LoadingStage); ``` -After defining your array of `LoadingStages` you can than run the loading process by using +After defining your array of `LoadingStages` you can then run the loading process by using `ui.runLoadingProcess(loadingStages, LOADING_STAGES_COUNT)`. This will give you a nice little loading animation you can see in the beginning of [this](https://vimeo.com/168362918) video.