From d549b8796c342b7a22423755d3a4a651a2efe4da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Toma=CC=81s=CC=8C=20S=CC=8Cesta=CC=81k?=
 <tomassestak@seznam.cz>
Date: Fri, 21 May 2021 22:25:50 +0200
Subject: [PATCH] IMPROVE README

---
 README.md    | 46 ++++++++++++++++++++++++++++++++++------------
 package.json |  2 +-
 2 files changed, 35 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 36c52b8..fe1bb16 100644
--- a/README.md
+++ b/README.md
@@ -16,27 +16,49 @@ yarn add react-spring-scroll-to-hook
 
 ## Usage
 
+useScrollTo hook accepts 1 argument a that is react-spring config: https://react-spring.io/common/configs
+scrollTo function returned from useScrollTo hook accepts 2 arguments:
+
+    1: Element | string | number (number of pixels from top of the window)
+    2: Number (offset in pixels from element you want to scroll to)
+
+I don't know how three shaking works but I would recommend using <b>@react-spring/web (used in this hook)</b> instead of react-spring
+
+## Examples
+
 ```tsx
 
 import {config} from '@react-spring/web'
 import useScrollTo from 'react-spring-scroll-to-hook'
 
+//Scroll to element
 const BasicExampleWthConfig = () => {
-	const {scrollTo} = useScrollTo(config.molasses)
-	return (
-		<button type="button" onClick={() => scrollTo(document.querySelector('#id'))}>
-			Scroll to Element
-		</button>
-	)
+    const {scrollTo} = useScrollTo(config.molasses)
+    return (
+        <button type="button" onClick={() => scrollTo(document.querySelector('#id'))}>
+            Scroll to Element with predefined config from react-spring
+        </button>
+    )
 }
 
+//Scroll to top
 const ScrollToTop = () => {
-	const {scrollTo} = useScrollTo()
-	return (
-		<button type="button" onClick={scrollTo}>
-			Scroll to the top of the page with default config
-		</button>
-	)
+    const {scrollTo} = useScrollTo({ mass: 1, tension: 180, friction: 12 })
+    return (
+        <button type="button" onClick={scrollTo}>
+            Scroll to the top of the page with your config
+        </button>
+    )
+}
+
+//Scroll to top with offset and first argument as string only (document.querySelector is used in the hook)
+const ScrollToTopWithOffset = () => {
+    const {scrollTo} = useScrollTo()
+    return (
+        <button type="button" onClick={() => scrollTo('#id', 300)}>
+            Scroll to the top of the page with default config and offset from element
+        </button>
+    )
 }
 
 ```
diff --git a/package.json b/package.json
index 82450c0..4e5bf21 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-spring-scroll-to-hook",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Simple custom hook for ScrollTo functionality using react-spring v9+.",
   "author": "TomasSestak",
   "license": "MIT",