Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Commit 58208da

Browse files
committed
[Task] docs, naming
1 parent aaaba5b commit 58208da

File tree

3 files changed

+28
-4
lines changed

3 files changed

+28
-4
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,27 @@ equal-height
44
(jQuery Plugin, Bower)
55

66
jQuery Plugin for getting and setting the min-height of given elements to the highest calculated value.
7+
8+
Usage
9+
-----
10+
11+
```html
12+
<div class="equal-container">
13+
<div class="equal">short</div>
14+
<div class="equal">Lorem ipsum dolor sit amet, consectetur adipisicing elit. Architecto veritatis reiciendis repellendus autem aspernatur asperiores nihil unde? Laborum cumque inventore nemo eum ab debitis adipisci a obcaecati nesciunt commodi doloribus.</div>
15+
<div class="equal">short</div>
16+
</div> <!-- equal-container -->
17+
``
18+
19+
```javascript
20+
$('.equal-container').each(function() {
21+
$(this).find('.equal').equalheight();
22+
});
23+
```
24+
25+
Installation
26+
------------
27+
28+
```shell
29+
bower install markusfalk/equal-height
30+
```

mf_EqualHeight.jquery.plugin.js renamed to jquery.equal-height.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
;(function($) {
77

8-
$.fn.mf_EqualHeight = function() {
8+
$.fn.equalheight = function() {
99

1010
var heights = 0;
1111

@@ -27,4 +27,4 @@
2727
return this;
2828
};
2929

30-
})(jQuery);
30+
})(jQuery);

test.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
<div>test2</div>
1919
</body>
2020
<script src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
21-
<script src="mf_EqualHeight.jquery.plugin.js"></script>
21+
<script src="jquery.equal-height.js"></script>
2222
<script>
2323
$('div').mf_EqualHeight();
2424
</script>
25-
</html>
25+
</html>

0 commit comments

Comments
 (0)