Permalink
Browse files

Add more info to readme

  • Loading branch information...
1 parent 91aaf1c commit 1503d85a65039eeabec0c70035fcc52f2a2d2e46 @lukasoppermann lukasoppermann committed on GitHub Dec 5, 2016
Showing with 42 additions and 0 deletions.
  1. +42 −0 README.md
View
@@ -4,6 +4,48 @@ Minigrid is a minimal 2kb zero dependency cascading grid layout.
Website & Documentation: [http://alves.im/minigrid](http://minigrid.js.org/).
+## Demo
+
+There's a simple example on [jsbin](http://jsbin.com/wamele/2).
+
+## Installation
+
+Using **NPM**
+
+```
+npm install minigrid --save
+```
+
+Or 1998 script tag from unpkg:
+
+```
+<script src="https://unpkg.com/minigrid@3.1.1/dist/minigrid.min.js"></script>
+```
+
+## Usage
+
+It works on a grid container with a group of grid items.
+```
+<div class="cards">
+ <div class="card"></div>
+ <div class="card"></div>
+ <div class="card"></div>
+</div>
+```
+
+Then:
+```
+var grid = new Minigrid({
+ container: '.cards',
+ item: '.card',
+ gutter: 6
+});
+grid.mount();
+```
+
+### Limitation
+Minigrid was built having in mind "cards" with same width and different heights. If your cards have different width sizes or you need more power Minigrid might not be right for you.
+
## Contributing
Plese see [CONTRIBUTING](CONTRIBUTING.md).

0 comments on commit 1503d85

Please sign in to comment.