summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index 36fc9a6..68cf13a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# jQuery Simple Equal Heights
-Version 1.3
+Version 1.4
## Summary
@@ -14,10 +14,18 @@ Matt Banks ( [@mattbanks](http://twitter.com/mattbanks) / [kernelcreativemedia.c
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).
+### Auto Initialize
+
+Add `data-heights="equal"` and `data-targets="MYELEMENTS"` to the parent container, where MYELEMENTS is div, section, whatever you'd like. [See the example](https://github.com/mattbanks/jQuery.equalHeights/blob/master/example/example.html) for more information.
+
+### Manually Initialize
+
$('.yourelements').equalHeights();
Select whatever elements need equal height.
+### Caveats
+
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
@@ -30,8 +38,16 @@ Works in IE6+, Chrome 14+, Safari 4+, Firefox 3.0+, Opera 10+.
See `example.html` in examples folder.
+## Contributors
+
+* [betweenbrain](https://github.com/betweenbrain)
+
### Changelog
+#### Version 1.4
+
+* allow auto initialization with `data-heights` and `data-targets` (props [betweenbrain](https://github.com/betweenbrain))
+
#### Version 1.3
* properly return the jQuery object to allow chaining
@@ -48,4 +64,4 @@ See `example.html` in examples folder.
#### Version 1.0
-* initial version
+* initial version \ No newline at end of file