Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnnyTheTank committed Nov 16, 2015
1 parent 276f169 commit 413c12d
Showing 1 changed file with 68 additions and 22 deletions.
90 changes: 68 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,75 @@
# bootstrap-block-grid
real block grid for bootstrap

# usage
```html
<div class="block-grid-xs-2 block-grid-sm-3 block-grid-md-4">
<div>
Content 1
</div>
<div>
Content 2
</div>
<div>
Content 3
</div>
<div>
Content 4
</div>
<div>
Content 5
</div>
<div>
Content 6
Author: Jonathan Hornung ([JohnnyTheTank](https://github.com/JohnnyTheTank))

## usage

1. Install:
1. via [bower](http://bower.io/)
`bower install --save bootstrap-block-grid`

2. via downloaded files

2. Add files to your html
1. when using bower
```html
<script src="bower_components/bootstrap-block-grid/dist/bootstrap-block-grid.min.css"></script>
```

2. when using downloaded files
```html
<script src="bootstrap-block-grid.min.css"></script>
```

3. Sample Markup

```html
<div class="block-grid-xs-2 block-grid-sm-3 block-grid-md-4">
<div>
Content 1
</div>
<div>
Content 2
</div>
<div>
Content 3
</div>
<div>
Content 4
</div>
<div>
Content 5
</div>
<div>
Content 6
</div>
</div>
</div>
```
```

## available classes

- *xs*
- `block-grid-xs-1`
- `block-grid-xs-2`
- ...
- `block-grid-xs-12`
- *sm*
- `block-grid-sm-1`
- `block-grid-sm-2`
- ...
- `block-grid-sm-12`
- *md*
- `block-grid-md-1`
- `block-grid-md-2`
- ...
- `block-grid-md-12`
- *lg*
- `block-grid-lg-1`
- `block-grid-lg-2`
- ...
- `block-grid-lg-12`


# licence
MIT

0 comments on commit 413c12d

Please sign in to comment.