Skip to content

Commit 83ec22c

Browse files
committed
Update doc.
1 parent 404a464 commit 83ec22c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@
66
77
## Usage
88

9+
There are total 4 interactive functions in this package.
10+
11+
* `better-scroll-down`
12+
* `better-scroll-up`
13+
* `better-scroll-down-other-window`
14+
* `better-scroll-up-other-window`
15+
16+
I will recommend to bind these function to global keys like the snippet below.
17+
918
```el
1019
(define-key global-map (kbd "<prior>") #better-scroll-down)
1120
(define-key global-map (kbd "<next>") #better-scroll-up)
@@ -14,6 +23,8 @@
1423
(define-key global-map (kbd "S-<next>") #better-scroll-up-other-window)
1524
```
1625

26+
*P.S. `<prior>` and `<next>` is corresponds to `page up` and `page down` key.*
27+
1728
## Contribution
1829

1930
If you would like to contribute to this project, you may either

0 commit comments

Comments
 (0)