added: documentation

Author: GianlucaGuarini

README.md

@@ -6,16 +6,60 @@
 [![NPM downloads][npm-downloads-image]][npm-url]
 [![MIT License][license-image]][license-url]
 
+[travis-image]: https://img.shields.io/travis/biancojs/viewport.svg?style=flat-square
 
-[travis-image]:https://img.shields.io/travis/biancojs/viewport.svg?style=flat-square
-[travis-url]:https://travis-ci.org/biancojs/viewport
+[travis-url]: https://travis-ci.org/biancojs/viewport
 
-[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
-[license-url]:LICENSE.txt
+[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
 
-[npm-version-image]:http://img.shields.io/npm/v/bianco.viewport.svg?style=flat-square
-[npm-downloads-image]:http://img.shields.io/npm/dm/bianco.viewport.svg?style=flat-square
-[npm-url]:https://npmjs.org/package/bianco.viewport
+[license-url]: LICENSE.txt
+
+[npm-version-image]: http://img.shields.io/npm/v/bianco.viewport.svg?style=flat-square
+
+[npm-downloads-image]: http://img.shields.io/npm/dm/bianco.viewport.svg?style=flat-square
+
+[npm-url]: https://npmjs.org/package/bianco.viewport
 
 ## API
 
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### 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
+
+### 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
+
+### 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
+
+### 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
+
+### scrollLeft
+
+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 left value in px
+
+### elementOffsetTop
+
+Get the offset top of any DOM element
+
+**Parameters**
+
+-   `el` **[HTMLElement](https://developer.mozilla.org/en-US/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

index.next.js

@@ -6,13 +6,15 @@ const ZERO = 0
 
 /**
  * Simple function convert in boolean any value and return true if its value was truthy
+ * @private
  * @param   {*} v - anything
  * @returns { Boolean } true if truthy
  */
 const isTruthy = v => !!v
 
 /**
  * Get the max value from a list of arguments filtering the falsy values
+ * @private
  * @param   {...Number} args - list of numbers
  * @returns { Number } the highest value
  */
@@ -84,7 +86,7 @@ export function scrollTop() {
 
 /**
  * Return amount of px scrolled from the top of the document
- * @returns { Number } scroll top value in px
+ * @returns { Number } scroll left value in px
  */
 export function scrollLeft() {
   return max(