diff --git a/README.md b/README.md index a527bfc69ba583df7b6afe6adb9f53cb4a1ce694..dc64b325928f8f68a519642088906177c84a69d7 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,12 @@ yarn add @grifart/smoothscroll ```javascript import SmoothScroll from '@grifart/smoothscroll'; +// use defaults +SmoothScroll(); + +// customize SmoothScroll({ - scrollOnLoad: true, + scrollOnLoad: false, scrollOnLinkClick: true, }); ``` @@ -36,6 +40,7 @@ SmoothScroll({ ## Development ```bash +yarn install yarn dev ```