Skip to content

Commit f8b881c

Browse files
authored
Update README.md
1 parent 48adc34 commit f8b881c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ time.sleep(30)
5252
simplehotkeys.add_hotkey(keys)
5353
input("from now no keypresses are handled")
5454
```
55-
Inputs key combination and for 30 seconds react to its events, then remove all the callbacks.
55+
Inputs key combination and for 30 seconds react to its events, then removes all the callbacks.
5656

5757
```
5858
now press your desired hotkey
@@ -65,7 +65,7 @@ from now no keypresses are handled
6565
```
6666

6767
## Instalation
68-
No option to install via `pip` yet.
68+
Currently no option to install via `pip`.
6969
Simply add the `simplehotkeys.py` to your project directory.
7070

7171

@@ -74,7 +74,10 @@ Simply add the `simplehotkeys.py` to your project directory.
7474
```python
7575
simplehotkeys.add_hotkey(keys_list, callback_on_press=None, callback_on_longpress=None, callback_on_toolongpress=None, callback_on_doublepress=None)
7676
```
77-
Sets up callbacks for given key combination and event. Note that there is little reaction delay that depends on what callbacks are set (when only `callback_on_press` is set calls callback on keydown, when `callback_on_longpress` or `callback_on_toolongpress` is set waits for the key release, when `callback_on_doublepress` is set waits for next keypress).
77+
Sets up callbacks for given key combination. Note that there is little reaction delay that depends on what callbacks are set (
78+
when only `callback_on_press` is set, the callback is called on keydown;
79+
when `callback_on_longpress` or `callback_on_toolongpress` is set, it waits for the key release;
80+
when `callback_on_doublepress` is set, waits for next keypress).
7881
Calling this function for the second time with same key_list will remove the old callbacks.
7982
To prevent blocking keypress detection, callbacks are always called as threads.
8083

0 commit comments

Comments
 (0)