Skip to content

Commit 413c12d

Browse files
committed
docs: updated readme
1 parent 276f169 commit 413c12d

File tree

1 file changed

+68
-22
lines changed

1 file changed

+68
-22
lines changed

README.md

+68-22
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,75 @@
11
# bootstrap-block-grid
22
real block grid for bootstrap
33

4-
# usage
5-
```html
6-
<div class="block-grid-xs-2 block-grid-sm-3 block-grid-md-4">
7-
<div>
8-
Content 1
9-
</div>
10-
<div>
11-
Content 2
12-
</div>
13-
<div>
14-
Content 3
15-
</div>
16-
<div>
17-
Content 4
18-
</div>
19-
<div>
20-
Content 5
21-
</div>
22-
<div>
23-
Content 6
4+
Author: Jonathan Hornung ([JohnnyTheTank](https://github.com/JohnnyTheTank))
5+
6+
## usage
7+
8+
1. Install:
9+
1. via [bower](http://bower.io/)
10+
`bower install --save bootstrap-block-grid`
11+
12+
2. via downloaded files
13+
14+
2. Add files to your html
15+
1. when using bower
16+
```html
17+
<script src="bower_components/bootstrap-block-grid/dist/bootstrap-block-grid.min.css"></script>
18+
```
19+
20+
2. when using downloaded files
21+
```html
22+
<script src="bootstrap-block-grid.min.css"></script>
23+
```
24+
25+
3. Sample Markup
26+
27+
```html
28+
<div class="block-grid-xs-2 block-grid-sm-3 block-grid-md-4">
29+
<div>
30+
Content 1
31+
</div>
32+
<div>
33+
Content 2
34+
</div>
35+
<div>
36+
Content 3
37+
</div>
38+
<div>
39+
Content 4
40+
</div>
41+
<div>
42+
Content 5
43+
</div>
44+
<div>
45+
Content 6
46+
</div>
2447
</div>
25-
</div>
26-
```
48+
```
49+
50+
## available classes
51+
52+
- *xs*
53+
- `block-grid-xs-1`
54+
- `block-grid-xs-2`
55+
- ...
56+
- `block-grid-xs-12`
57+
- *sm*
58+
- `block-grid-sm-1`
59+
- `block-grid-sm-2`
60+
- ...
61+
- `block-grid-sm-12`
62+
- *md*
63+
- `block-grid-md-1`
64+
- `block-grid-md-2`
65+
- ...
66+
- `block-grid-md-12`
67+
- *lg*
68+
- `block-grid-lg-1`
69+
- `block-grid-lg-2`
70+
- ...
71+
- `block-grid-lg-12`
72+
2773

2874
# licence
2975
MIT

0 commit comments

Comments
 (0)