Skip to content

Commit ab1f855

Browse files
committed
Update readme
1 parent 3821519 commit ab1f855

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

readme.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Interact with [CSS scroll-snap](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Scroll_Snap).
44

5+
Zero dependencies.
6+
7+
Automatically accounts for `scroll-padding`.
8+
59
## Install
610

711
```shell
@@ -10,7 +14,7 @@ yarn add scroll-snap-api
1014
npm install --save scroll-snap-api
1115
```
1216

13-
Or import directly
17+
Or use directly
1418

1519
```js
1620
import * as scrollSnapApi from 'https://cdn.pika.dev/scroll-snap-api';
@@ -71,4 +75,5 @@ const snap = getSnapPositions( scrollingElement );
7175
## TODO
7276

7377
- More documentation
78+
- Pass scroll behaviour args
7479
- Support `dir="rtl"`

0 commit comments

Comments
 (0)