From 688f0acd52c021617fe3abeb23bbfa915fa0bfd9 Mon Sep 17 00:00:00 2001
From: Matthias Hertel <mathertel@hotmail.com>
Date: Thu, 1 Aug 2024 20:14:46 +0200
Subject: [PATCH] Docu and version 2.6

---
 README.md          | 47 ++++++++++++++++++++++++++++++++++++++++++++--
 library.json       |  2 +-
 library.properties |  2 +-
 3 files changed, 47 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index aafdfa4..f15348c 100644
--- a/README.md
+++ b/README.md
@@ -24,10 +24,53 @@ a copy of this library. You can find more detail about installing libraries
 #include <OneButton.h>
 ```
 
-Each physical button requires its own `OneButton` instance. You can initialize them like this:
+Each physical button requires its own `OneButton` instance.
 
 
-### OneButton Tiny version
+### Initialize on Instance creation (old way)
+
+You can create a global instance and pass the hardware configurtion directly at compile time:
+
+```cpp
+// Declare and initialize
+OneButton btn = OneButton(
+  BUTTON_PIN,  // Input pin for the button
+  true,        // Button is active LOW
+  true         // Enable internal pull-up resistor
+);
+```
+
+This works for most boards.  However, some boards will initialize the hardware AFTER the initialization of global
+defined instances and the Input pin will not work at all.
+
+
+### Explicit setup and deferred initialization (new, more compatible option)
+
+By using an explicit initialization using the `setup(...)` function solves the problem of the initialization order.
+Also this is also a good option in case you do not know the Hardware configuration at compile time.
+
+Declare a global instance, un-initialized:
+
+```cpp
+OneButton btn;
+```
+
+In the main `setup()` function the instance will be initialized by passing the hardware configuration.  Pass the input
+mode as known from pinMode():
+
+```cpp
+btn.setup(
+  BUTTON_PIN,   // Input pin for the button
+  INPUT_PULLUP, // INPUT and enable the internal pull-up resistor
+  true          // Button is active LOW
+);
+```
+
+In the SimpleOneButton example shows how to use this sequence.  In the new `setup(...)` function the pinMode can be
+given in the second parameter to allow all kind of hardware options.
+
+
+## OneButton Tiny version
 
 The OneButton Library was extended over time with functionality that was requested for specific
 use cases. This makes the library growing over time too and therefore was limiting use cases using very small processors like attiny84.
diff --git a/library.json b/library.json
index ae2b7f2..c321b38 100644
--- a/library.json
+++ b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "OneButton",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "keywords": "arduino, button, pushbutton",
   "description": "This Arduino library is improving the usage of a singe button for input. It shows how to use an digital input pin with a single pushbutton attached for detecting some of the typical button press events like single clicks, double clicks and long-time pressing. This enables you to reuse the same button for multiple functions and lowers the hardware invests.",
   "repository": {
diff --git a/library.properties b/library.properties
index 3767bb2..a2c6bef 100644
--- a/library.properties
+++ b/library.properties
@@ -1,5 +1,5 @@
 name=OneButton
-version=2.5.0
+version=2.6.0
 author=Matthias Hertel
 maintainer=Matthias Hertel, https://www.mathertel.de
 sentence=Arduino library for improving the usage of a singe input button.