Skip to content

Commit 75ee9bc

Browse files
committed
Add detail for creating instances of the class
1 parent 238d8dc commit 75ee9bc

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ If you turn on debugging it will show the row and column selection making it eas
3333
## Methods
3434

3535
```c++
36+
TapCode tapInput(uint8_t tap_button, uint8_t mode = INPUT_PULLUP); //Declare an instance 'tapInput' and start a tap input on pin tap_button. The library controls the pin and does not need pinMode setting before this. Default is INPUT_PULLUP but this can be overriden.
37+
3638
void begin(uint8_t max_length = 64, uint32_t press_timeout = 1000, uint32_t word_timeout = 5000); //Start the tap input
3739

3840
void read(); //Do housekeeping checking for pushes, run in loop to update the word as the button is tapped

0 commit comments

Comments
 (0)