diff --git a/README.md b/README.md index a57e613..6623537 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
Scroll Direction

Scroll Direction

-

A lightweight jQuery plugin to detect scroll direction on your website.

+

A lightweight Javascript plugin to detect scroll direction on your website.

@@ -9,17 +9,18 @@ - + + +made-in-vietnam +
> **Update**: Scroll Direction now works with other libraries that hijack the native scrollbar (like Locomotive Scroll). -**[View demo on CodePen →](https://codepen.io/phucbui/pen/yLaeqBw)** - ## Getting started -### Download locally +### Self-hosting You can [download the plugin directly from Github](https://raw.githubusercontent.com/phucbm/jquery-scroll-direction-plugin/main/jquery.scroll-direction.js) @@ -27,7 +28,7 @@ can [download the plugin directly from Github](https://raw.githubusercontent.com ```html - + ``` ### Using CDN @@ -36,15 +37,15 @@ You can also browse for the latest version by visiting [Scroll Direction on jsDelivr](https://cdn.jsdelivr.net/gh/phucbm/jquery-scroll-direction-plugin/) ```html - - + + ``` or minified version ```html - - + + ``` ### Initialize Scroll Direction @@ -52,8 +53,11 @@ or minified version After init, you will have some classes on your body tag to indicate the scroll direction and position. ```js -// init Scroll Direction +// jQuery $.scrollDirection.init(); + +// Pure JS +window.scrollDirection.init(); ``` ```html @@ -193,4 +197,4 @@ And start test server ```shell gulp serve -``` \ No newline at end of file +```