updated: documentation

Author: GianlucaGuarini

README.md

@@ -6,6 +6,15 @@
 [![NPM downloads][npm-downloads-image]][npm-url]
 [![MIT License][license-image]][license-url]
 
+## Usage
+
+```js
+import viewport from 'bianco.viewport'
+
+// get the current scroll top position
+const offsetTop = viewport.scrollTop()
+```
+
 [travis-image]: https://img.shields.io/travis/biancojs/viewport.svg?style=flat-square
 
 [travis-url]: https://travis-ci.org/biancojs/viewport
@@ -24,52 +33,64 @@
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
+#### Table of Contents
+
+-   [scrollbarWidth](#scrollbarwidth)
+-   [documentHeight](#documentheight)
+-   [documentWidth](#documentwidth)
+-   [scrollTop](#scrolltop)
+-   [scrollLeft](#scrollleft)
+-   [elementOffsetTop](#elementoffsettop)
+    -   [Parameters](#parameters)
+-   [elementOffsetLeft](#elementoffsetleft)
+    -   [Parameters](#parameters-1)
+
 ### scrollbarWidth
 
 Return the size of the scrollbar that depends on the browser or device used on the client
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the browser scrollbar width
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the browser scrollbar width
 
 ### documentHeight
 
 Get the height of the whole page
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** height in px of the document
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** height in px of the document
 
 ### documentWidth
 
 Get the width of the whole page
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** width in px of the document
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** width in px of the document
 
 ### scrollTop
 
 Return amount of px scrolled from the top of the document
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** scroll top value in px
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** scroll top value in px
 
 ### scrollLeft
 
 Return amount of px scrolled from the left of the document
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** scroll left value in px
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** scroll left value in px
 
 ### elementOffsetTop
 
 Get the offset top of any DOM element
 
-**Parameters**
+#### Parameters
 
--   `el` **[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)** the element we need to check
+-   `el` **[HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element)** the element we need to check
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the element y position in px
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the element y position in px
 
 ### elementOffsetLeft
 
 Get the offset left of any DOM element
 
-**Parameters**
+#### Parameters
 
--   `el` **[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)** the element we need to check
+-   `el` **[HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element)** the element we need to check
 
-Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** the element x position in px
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the element x position in px