From a80088ffdad6c870c66a30f33f7ff1f3587b2dbb Mon Sep 17 00:00:00 2001 From: Daniel Kurowski <daniel.kurowski@grifart.cz> Date: Fri, 29 May 2020 16:02:00 +0200 Subject: [PATCH] Improved readme --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a527bfc..dc64b32 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 ``` -- GitLab