Skip to content

Commit

Permalink
updated descr.
Browse files Browse the repository at this point in the history
  • Loading branch information
LennartHennigs committed Feb 21, 2021
1 parent fea22be commit 9107c8f
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ Some of the code based on the library by PJRC (https://www.pjrc.com/teensy/td_li
How to Use
----------

The library provides several callback handlers to be notified when the rotary encoder position changes.

It does not detect the button click - you have to use a seperate library for this, e.g. [Button2](https://github.com/LennartHennigs/Button2).

It does not detect the button click -
**Note:** For the class to work, you need to call the `loop()` member function in your sketch's `loop()` function. See the example for more details.

These are the constructor and the member functions the library provides:

Expand All @@ -45,11 +48,6 @@ These are the constructor and the member functions the library provides:
void loop();
```

The library provides several callback handlers to be notified when the rotary encoder position changes.

**Note:** For the class to work, you need to call the `loop()` member function in your sketch's `loop()` function. See the example for more details.


Installation
------------
Open the Arduino IDE choose "Sketch > Include Library" and search for "ESP Rotary".
Expand Down

0 comments on commit 9107c8f

Please sign in to comment.