Skip to content

Commit 9a74131

Browse files
author
Maciej Gurban
committed
Updating the docs.
1 parent 377b208 commit 9a74131

File tree

2 files changed

+24
-39
lines changed

2 files changed

+24
-39
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,36 @@
11
# Responsive Bootstrap Toolkit
22

3+
Responsive Bootstrap Toolkit provides an easy way of breakpoint detection in JavaScript, detecting changes in currently active breakpoint, as well as executing any breakpoint-specific JavaScript code. Despite the name, you can use it also with Foundation, or any other framework.
34

4-
Responsive Bootstrap Toolkit provides an easy way of breakpoint detection in JavaScript, detecting changes in currently active breakpoint, as well as executing any breakpoint-specific JavaScript code.
5+
Current version: **2.5.0**
56

6-
The SASS module enables quick and simple styling for elements needing different property values for each screen resolution.
7-
8-
Current version: **2.4.2**
9-
10-
### Table of Contents
7+
### Documentation
118
* [Installation](#installation)
12-
* [Live example](#live-example)
9+
* [Demo](#demo)
10+
* [Basic usage](#basic-usage)
11+
* [Execute code on window resize](#execute-code-on-window-resize)
12+
* [Get alias of current breakpoint](#get-alias-of-current-breakpoint)
13+
* [Using with Foundation](#using-with-foundation)
14+
* [Providing your own visibility classes](#providing-your-own-visibility-classes)
15+
16+
### HOW-TO
17+
* [How do I include it in my project?](#how-do-i-include-it-in-my-project)
1318
* [Migrating from an older version](#migrating-from-an-older-version)
14-
* JavaScript features
15-
* [Basic usage](#basic-usage)
16-
* [Execute code on window resize](#execute-code-on-window-resize)
17-
* [Get alias of current breakpoint](#get-alias-of-current-breakpoint)
18-
* [Using with Foundation](#using-with-foundation)
19-
* [Providing your own visibility classes](#providing-your-own-visibility-classes)
20-
* [How do I include it in my project?](#how-do-i-include-it-in-my-project)
21-
* [Dependencies](#dependencies)
19+
* [Dependencies](#dependencies)
2220

2321
### Installation
2422
````
2523
bower install https://github.com/maciej-gurban/responsive-bootstrap-toolkit.git
2624
````
2725

28-
### Live example
26+
### Demo
2927

30-
Available on [CodePen](http://codepen.io/dih/full/ivECj)
28+
Live example available on [CodePen](http://codepen.io/dih/full/ivECj). Hosted along with repository are the following usage examples:
29+
* [Bootstrap demo](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/tree/master/demos/bootstrap)
30+
* [Foundation demo](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/tree/master/demos/foundation)
31+
* [Custom breakpoints demo](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/tree/master/demos/custom)
3132

32-
### Migrating from an older version
33-
34-
Refer to the [changelog](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/blob/master/CHANGELOG.md) for a list of changes in each version of the library.
3533

36-
### JavaScript features
3734
#### Basic usage:
3835

3936
````javascript
@@ -76,7 +73,7 @@ $(window).resize(
7673

7774
// ...
7875

79-
}, 600)
76+
}, 150)
8077
});
8178
````
8279

@@ -131,7 +128,7 @@ Currently, only Foundation 5 visibility classes are supported. If you'd like to
131128
````
132129

133130
**Note**:
134-
It's up to you to create media queries that will toggle div's visibility across different screen resolutions. How? Refer to this example.
131+
It's up to you to create media queries that will toggle div's visibility across different screen resolutions. How? [Refer to this example](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/blob/master/demos/custom/style.css).
135132

136133
#### How do I include it in my project?
137134

@@ -144,6 +141,10 @@ Paste just before `</body>`
144141
<script src="js/main.js"></script>
145142
````
146143

144+
### Migrating from an older version
145+
146+
Refer to the [changelog](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/blob/master/CHANGELOG.md) for a list of changes in each version of the library.
147+
147148
#### Dependencies:
148149
* jQuery
149150
* Bootstrap's responsive utility css classes (included in its standard stylesheet package)

demos/foundation/style.css

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,3 @@
11
body {
22
font-family: 'Open Sans', sans-serif;
33
}
4-
5-
@media (max-width: 480px) {
6-
.visible-custom-1 { display: block; }
7-
.visible-custom-2 { display: none; }
8-
.visible-custom-3 { display: none; }
9-
}
10-
@media (min-width: 481px) and (max-width: 799px) {
11-
.visible-custom-1 { display: none; }
12-
.visible-custom-2 { display: block; }
13-
.visible-custom-3 { display: none; }
14-
}
15-
@media (min-width: 800px) {
16-
.visible-custom-1 { display: none; }
17-
.visible-custom-2 { display: none; }
18-
.visible-custom-3 { display: block; }
19-
}

0 commit comments

Comments
 (0)