summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Banks <mjbanks@gmail.com>2012-05-05 17:49:46 -0400
committerMatt Banks <mjbanks@gmail.com>2012-05-05 17:49:46 -0400
commit5dccc25b37ac41e3830f9bd5e6c1489850133411 (patch)
tree3decdfacef83db0f123923c1ca3043ed00a5c509
parentbabc1b2489ebd5b845812b3c28ef84bda62b7980 (diff)
downloadjQuery.equalHeights-5dccc25b37ac41e3830f9bd5e6c1489850133411.zip
jQuery.equalHeights-5dccc25b37ac41e3830f9bd5e6c1489850133411.tar.gz
jQuery.equalHeights-5dccc25b37ac41e3830f9bd5e6c1489850133411.tar.bz2
added change log, contributors, and updated usage
-rw-r--r--README.md25
1 files changed, 22 insertions, 3 deletions
diff --git a/README.md b/README.md
index accff61..34bcc50 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,24 @@
# jQuery Simple Equal Heights
+Version 1.1
+
+## Summary
+
Simple jQuery plugin to equalize heights of multiple elements on a page.
+## Contributors:
+
+Matt Banks ( [@mattbanks](http://twitter.com/mattbanks) / [kernelcreativemedia.com](http://www.kernelcreativemedia.com) / [mattbanks.me](http://www.mattbanks.me) )
+
## Usage
Include `jquery.equalheights.min.js` after calling jQuery in the footer. Alternatively, include in your `plugins.js` file if using [HTML5 Boilerplate](http://html5boilerplate.com).
- $('#equalheight div').equalHeights();
+ $('.yourelements').equalHeights();
Select whatever elements need equal height.
-If using @font-face or Google Web Fonts, wrap selector in a `setTimeout` for 100ms (`jQuery.height()` needs to fire after the font is rendered to properly calculate the height).
+If using @font-face or Google Web Fonts, you may need to wrap the function call in a `setTimeout` for 100ms-200ms (`jQuery.height()` needs to fire after the font is rendered to properly calculate the height).
## Requirements/Browsers
@@ -20,4 +28,15 @@ Works in IE6+, Chrome 14+, Safari 4+, Firefox 3.0+, Opera 10+.
## Examples
-See `example.html` in examples folder. \ No newline at end of file
+See `example.html` in examples folder.
+
+### Changelog
+
+#### Version 1.1
+
+* cleaned up function call
+* updated `example.html` to properly validate
+
+#### Version 1.0
+
+* initial version \ No newline at end of file