Update docs and site

README.md

@@ -10,4 +10,4 @@ Plese see [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
 
-MIT © 2016 [Henrique Alves](http://alves.im)
+MIT © 2016 [Henrique Alves](http://twitter.com/healves82)

site/index.html

@@ -9,6 +9,6 @@
   gutter: 6
 });
 grid.mount();
-</code></pre><h2>Installation</h2><p>Get it from <strong>npm</strong>.</p><pre><code>npm install minigrid
-</code></pre><p>Or 1998 script tag from <a href="https://unpkg.com/minigrid@3.0.6/dist/minigrid.min.js">unpkg</a>:</p><pre><code>&lt;script src=&quot;https://unpkg.com/minigrid@3.0.6/dist/minigrid.min.js&quot;&gt;&lt;/script&gt;
-</code></pre><h2>Upgrade</h2><p>Upgrading from v1.x or v2.x?</p><p>Please read the <a href="https://github.com/henriquea/minigrid/blob/master/CHANGELOG.md">CHANGELOG</a> for API changes.</p><h2>Limitations</h2><p>Minigrid was built having in mind &quot;cards&quot; with same width and different heights. If your cards have different width sizes or you need more power I would recommend <a href="http://isotope.metafizzy.co/">Isotope</a>.</p><h2>Questions</h2><p>Open an <a href="https://github.com/henriquea/minigrid/issues">issue</a> or hit me on Twitter.</p><p><a href="https://twitter.com/share" class="twitter-share-button" data-url="http://alves.im/minigrid" data-text="Minimal 2kb zero dependencies cascading grid layout" data-via="healves82" data-hashtags="javascript">Tweet Project</a></p><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script><ul><li><a href="http://alves.im/minigrid">Minigrid</a> v3.0.6</li><li><a href="https://github.com/henriquea/minigrid">GitHub</a></li><li><a href="https://www.npmjs.com/package/minigrid">npm</a></li><li><a href="https://js.org"><img src="https://logo.js.org/dark_horz.png" width="55"></a></li></ul></div><script async defer="defer" id="github-bjs" src="https://buttons.github.io/buttons.js"></script><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-58573505-3', 'auto'); ga('send', 'pageview');</script></body></html>
+</code></pre><h2>Props</h2><ul><li>container: <code>string</code> or <code>Node</code></li><li>item: <code>string</code> or <code>NodeList</code></li><li>gutter: <code>number</code></li><li>rtl: <code>boolean</code></li></ul><h2>Installation</h2><p>Get it from <strong>npm</strong>.</p><pre><code>npm install minigrid
+</code></pre><p>Or 1998 script tag from <a href="https://unpkg.com/minigrid@3.1.0/dist/minigrid.min.js">unpkg</a>:</p><pre><code>&lt;script src=&quot;https://unpkg.com/minigrid@3.1.0/dist/minigrid.min.js&quot;&gt;&lt;/script&gt;
+</code></pre><h2>Upgrade</h2><p>Upgrading from v1.x or v2.x?</p><p>Please read the <a href="https://github.com/henriquea/minigrid/blob/master/CHANGELOG.md">CHANGELOG</a> for API changes.</p><h2>Limitations</h2><p>Minigrid was built having in mind &quot;cards&quot; with same width and different heights. If your cards have different width sizes or you need more power I would recommend <a href="http://isotope.metafizzy.co/">Isotope</a>.</p><h2>Questions</h2><p>Open an <a href="https://github.com/henriquea/minigrid/issues">issue</a> or hit me on Twitter.</p><p><a href="https://twitter.com/share" class="twitter-share-button" data-url="http://alves.im/minigrid" data-text="Minimal 2kb zero dependencies cascading grid layout" data-via="healves82" data-hashtags="javascript">Tweet Project</a></p><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script><ul><li><a href="http://alves.im/minigrid">Minigrid</a> v3.1.0</li><li><a href="https://github.com/henriquea/minigrid">GitHub</a></li><li><a href="https://www.npmjs.com/package/minigrid">npm</a></li><li><a href="https://js.org"><img src="https://logo.js.org/dark_horz.png" width="55"></a></li></ul></div><script async defer="defer" id="github-bjs" src="https://buttons.github.io/buttons.js"></script><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-58573505-3', 'auto'); ga('send', 'pageview');</script></body></html>

site/index.md

@@ -36,6 +36,13 @@ var grid = new Minigrid({
 grid.mount();
 ```
 
+## Props
+
+- container: `string` or `Node`
+- item: `string` or `NodeList`
+- gutter: `number`
+- rtl: `boolean`
+
 ## Installation
 
 Get it from <strong>npm</strong>.