updated: documentation

Author: GianlucaGuarini

README.md

@@ -10,6 +10,7 @@ Modern images loader helpers written in es2015 using generators and promises
 ## Usage
 
 #### Load a single image
+
 ```js
 import { loadImage } from 'bianco.images-loader'
 
@@ -42,7 +43,6 @@ loadImages([
   .catch(error => {
     // there was an error loading one of images
   })
-
 ```
 
 Or also...
@@ -56,7 +56,6 @@ loadImages($('img', '.main-content'))
   .catch(error => {
     // there was an error loading one of images
   })
-
 ```
 
 #### Lazy load sequentially images using a generator
@@ -88,18 +87,48 @@ for (let promise of infiniteList) {
 }
 ```
 
+[travis-image]: https://img.shields.io/travis/biancojs/images-loader.svg?style=flat-square
+
+[travis-url]: https://travis-ci.org/biancojs/images-loader
+
+[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
+
+[license-url]: LICENSE.txt
+
+[npm-version-image]: http://img.shields.io/npm/v/bianco.images-loader.svg?style=flat-square
+
+[npm-downloads-image]: http://img.shields.io/npm/dm/bianco.images-loader.svg?style=flat-square
+
+[npm-url]: https://npmjs.org/package/bianco.images-loader
+
 ## API
 
-- `loadImage(String|Image)` load an image returning a promise
-- `loadImages(Array|NodeList)` load in parallel multiple images returning a promise
-- `loadImagesGen(Array|NodeList)` load multiple images sequentially returning a ES6 generator
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### loadImage
+
+Preload any image
+
+**Parameters**
+
+-   `img` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element))** Path to the image or image object
+
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** a promise that will be resolved when the image will be completely loaded
+
+### loadImages
+
+Load in parallel a collection of images
+
+**Parameters**
+
+-   `imgs` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList))** array of strings or <img> HTML elements
+
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** a promise that will be resolved when all the images will be loaded
+
+### loadImagesGen
 
-[travis-image]:https://img.shields.io/travis/biancojs/images-loader.svg?style=flat-square
-[travis-url]:https://travis-ci.org/biancojs/images-loader
+Load sequentially a collection of images
 
-[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
-[license-url]:LICENSE.txt
+**Parameters**
 
-[npm-version-image]:http://img.shields.io/npm/v/bianco.images-loader.svg?style=flat-square
-[npm-downloads-image]:http://img.shields.io/npm/dm/bianco.images-loader.svg?style=flat-square
-[npm-url]:https://npmjs.org/package/bianco.images-loader
+-   `imgs` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList))** array of strings or <img> HTML elements

package.json

@@ -8,6 +8,7 @@
     "prepublish": "npm run build && npm test",
     "lint": "eslint index.next.js test.js rollup.config.js",
     "build": "rollup -c",
+    "doc": "documentation readme index.next.js -s API",
     "test": "npm run lint && mocha test.js"
   },
   "files": [