From 413c12d9afb16f321200fc11ec232559e7b89f17 Mon Sep 17 00:00:00 2001 From: Jonathan Hornung Date: Mon, 16 Nov 2015 17:29:26 +0100 Subject: [PATCH] docs: updated readme --- README.md | 90 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 68 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 122ff7d..d7b3438 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,75 @@ # bootstrap-block-grid real block grid for bootstrap -# usage -```html -
-
- Content 1 -
-
- Content 2 -
-
- Content 3 -
-
- Content 4 -
-
- Content 5 -
-
- 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 + + ``` + + 2. when using downloaded files + ```html + + ``` + +3. Sample Markup + + ```html +
+
+ Content 1 +
+
+ Content 2 +
+
+ Content 3 +
+
+ Content 4 +
+
+ Content 5 +
+
+ Content 6 +
-
-``` + ``` + +## 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 \ No newline at end of file