Skip to content
This repository has been archived by the owner on May 14, 2019. It is now read-only.

Add more info to readme #63

Merged
merged 1 commit into from Dec 7, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
Expand Up @@ -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).
Expand Down