Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liabru committed Apr 15, 2014
1 parent b1ed72d commit b62297b
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

[brm.io/jquery-match-height](http://brm.io/jquery-match-height/)

I needed a more robust version of the common [equal heights](https://www.google.com/search?q=jquery+equal+heights) plugin (that everyone and their grandma has made before).

I needed a more robust version of the common [equal heights](https://www.google.com/search?q=jquery+equal+heights) plugin.
So matchHeight improves on these by adding features and handling the edge cases where the others tend to fail in practice.

### Demo
Expand All @@ -26,7 +25,7 @@ See the [jquery.matchHeight.js demo](http://brm.io/jquery-match-height-demo).

### Status

Current version is `v0.5.0`. I've fully tested it and it works well, but if you use it make sure you test fully too.
Current version is `v0.5.1`. I've fully tested it and it works well, but if you use it make sure you test fully too.
Please report any [issues](https://github.com/liabru/jquery-match-height/issues) you find.

### Install
Expand All @@ -36,6 +35,10 @@ Please report any [issues](https://github.com/liabru/jquery-match-height/issues)

<script src="jquery.matchHeight.js" type="text/javascript"></script>

#### Or install using [Bower](http://bower.io/)

bower install matchHeight

### Usage

$(elements).matchHeight(byRow);
Expand Down Expand Up @@ -71,6 +74,10 @@ Will set both elements in `my-group` to the same height, then both elements in `

See the included [test.html](https://github.com/liabru/jquery-match-height/blob/master/test.html) for a working example.

### Changelog

To see what's new or changed in the latest version, see the [changelog](https://github.com/liabru/jquery-match-height/blob/master/CHANGELOG.md)

### Advanced Usage

There are a few internal properties and functions you should know about:
Expand Down

0 comments on commit b62297b

Please sign in to comment.