diff --git a/README.md b/README.md index 0fbdd160d8770301e90c2867f40a13af540fe100..e7898a41d32d353256afdb2d4c08735479202cdc 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,10 @@ SmoothScroll.enable({ | Option | Value | Default value | Description | | --- | --- | --- | --- | -| `scrollOnLoad` | `true`/`false` | `true` | Causes smooth scroll to anchored element when the page is loaded.\* +| `scrollOnLoad`\* | `true`/`false` | `true` | Causes smooth scroll to anchored element when the page is loaded. | `scrollOnLinkClick` | `true`/`false` | `true` | Causes smooth scroll on given element when user clicks on an `a` tag having `href` starting with `#` character. -\*Note: when the page load lasts more than 500 ms, load smooth scrolling is disabled as it would lead to user-unfriendly behaviour like jumping on the page up and down. +\*Note: when the page load lasts more than 500 ms, load smooth scroll effect is disabled as it would lead to user-unfriendly behaviour like jumping on the page up and down due to browser native behaviour. ## Development