Add readme and package improvements

Author: AndrzejSala

README.md

@@ -1,4 +1,10 @@
 # use-scroll-direction
+[![Latest Stable Version](https://img.shields.io/npm/v/use-scroll-direction.svg)](https://www.npmjs.com/package/use-scroll-direction)
+[![CI Status](https://github.com/AndrzejSala/use-scroll-direction/workflows/CI/badge.svg)](https://github.com/AndrzejSala/use-scroll-direction/actions)
+[![Gzipped size](https://img.shields.io/bundlephobia/min/use-scroll-direction?label=size)](https://www.npmjs.com/package/use-scroll-direction)
+[![License](https://img.shields.io/npm/l/use-scroll-direction.svg)](./LICENSE)
+[![NPM total downloads](https://img.shields.io/npm/dt/use-scroll-direction.svg)](https://npmcharts.com/compare/use-scroll-direction?minimal=true)
+
 A simple, performant and versatile hook for handling scroll in your react app.
 
 ## Installation
@@ -7,9 +13,9 @@ npm i use-scroll-direction
 ```
 
 ## Usage
-The hook returns the actual scroll direction which could be one of three states: **'NONE', 'DOWN', 'UP'**;
+The hook returns the actual scroll direction which could be one of three states: **'NONE'**, **'DOWN'**, **'UP'**;
 
-### On window
+### Use on window object
 ```tsx
 import {useScrollDirection} from "use-scroll-direction";
 
@@ -25,7 +31,7 @@ export const WindowExample = () => {
 };
 
 ```
-### On the element ref
+### Use on the specific element
 ```tsx
 import {useScrollDirection} from "use-scroll-direction";
 
@@ -34,11 +40,20 @@ export const ComponentRefExample = () => {
     const scrollDirection = useScrollDirection({ref: elementRef});
 
     return (
+        //The content needs to overflow a container
         <div ref={elementRef} style={{height: '100vh', overflowY: 'scroll'}} >
             <div>{...}</div>
         </div>
     )
 };
 ```
 
-For more specific examples, check the demo app in `./example`
+For more specific examples, check the demo app in `./example`
+
+## Available options
+
+| Name | Type | Description |
+| - | - | - |
+| `wait` | `?number` | Time in ms for throttling of scroll handler (default: 50)
+| `timeToReset` | `?number` | Time in ms after last scroll event to reset the state (default: 250)
+| `ref` | `?string` | When passed, the listener will be attached to element instead of window object 

package-lock.json

@@ -1,5 +1,23 @@
 {
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "description": "A simple, performant, and cross-browser hook for handling scroll in your next react app.",
+  "keywords": [
+    "react",
+    "hook",
+    "custom-hook",
+    "typescript",
+    "detect",
+    "scroll",
+    "scrolling",
+    "direction",
+    "position",
+    "window",
+    "ref",
+    "frontend"
+  ],
+  "bugs": {
+    "url": "https://github.com/AndrzejSala/use-scroll-direction/issues"
+  },
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -10,6 +28,10 @@
   "engines": {
     "node": ">=10"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AndrzejSala/use-scroll-direction"
+  },
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
@@ -35,7 +57,7 @@
     "trailingComma": "es5"
   },
   "name": "use-scroll-direction",
-  "author": "Andrzej Sala",
+  "author": "Andrzej Sala <[email protected]>",
   "module": "dist/use-scroll-direction.esm.js",
   "size-limit": [
     {