Skip to content

Commit

Permalink
Updating the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Maciej Gurban committed May 14, 2015
1 parent 377b208 commit 9a74131
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 39 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,36 @@
# Responsive Bootstrap Toolkit

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.

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.
Current version: **2.5.0**

The SASS module enables quick and simple styling for elements needing different property values for each screen resolution.

Current version: **2.4.2**

### Table of Contents
### Documentation
* [Installation](#installation)
* [Live example](#live-example)
* [Demo](#demo)
* [Basic usage](#basic-usage)
* [Execute code on window resize](#execute-code-on-window-resize)
* [Get alias of current breakpoint](#get-alias-of-current-breakpoint)
* [Using with Foundation](#using-with-foundation)
* [Providing your own visibility classes](#providing-your-own-visibility-classes)

### HOW-TO
* [How do I include it in my project?](#how-do-i-include-it-in-my-project)
* [Migrating from an older version](#migrating-from-an-older-version)
* JavaScript features
* [Basic usage](#basic-usage)
* [Execute code on window resize](#execute-code-on-window-resize)
* [Get alias of current breakpoint](#get-alias-of-current-breakpoint)
* [Using with Foundation](#using-with-foundation)
* [Providing your own visibility classes](#providing-your-own-visibility-classes)
* [How do I include it in my project?](#how-do-i-include-it-in-my-project)
* [Dependencies](#dependencies)
* [Dependencies](#dependencies)

### Installation
````
bower install https://github.com/maciej-gurban/responsive-bootstrap-toolkit.git
````

### Live example
### Demo

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

### Migrating from an older version

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.

### JavaScript features
#### Basic usage:

````javascript
Expand Down Expand Up @@ -76,7 +73,7 @@ $(window).resize(

// ...

}, 600)
}, 150)
});
````

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

**Note**:
It's up to you to create media queries that will toggle div's visibility across different screen resolutions. How? Refer to this example.
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).

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

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

### Migrating from an older version

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.

#### Dependencies:
* jQuery
* Bootstrap's responsive utility css classes (included in its standard stylesheet package)
16 changes: 0 additions & 16 deletions demos/foundation/style.css
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
body {
font-family: 'Open Sans', sans-serif;
}

@media (max-width: 480px) {
.visible-custom-1 { display: block; }
.visible-custom-2 { display: none; }
.visible-custom-3 { display: none; }
}
@media (min-width: 481px) and (max-width: 799px) {
.visible-custom-1 { display: none; }
.visible-custom-2 { display: block; }
.visible-custom-3 { display: none; }
}
@media (min-width: 800px) {
.visible-custom-1 { display: none; }
.visible-custom-2 { display: none; }
.visible-custom-3 { display: block; }
}

0 comments on commit 9a74131

Please sign in to comment.