Skip to content

Commit ad30d62

Browse files
committed
Added better instructions and MIT license
1 parent 13ec7dc commit ad30d62

File tree

2 files changed

+43
-8
lines changed

2 files changed

+43
-8
lines changed

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2013 Izilla Partners Pty Ltd
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,31 @@
1-
jQuery RWD Image Maps
2-
==============================
1+
# jQuery RWD Image Maps
32

43
### Allows image maps to be used in a responsive design by recalculating the area coordinates to match the actual image size on load and window.resize
54

6-
* * *
5+
---
76

8-
Usage:
7+
**Usage:**
98

10-
$('img[usemap]').rwdImageMaps();
9+
* Add a link to jQuery in your page, preferably at the bottom just before the closing `</body>`
10+
* After jQuery, either in a `<script>` block or a separate file, call:
1111

12-
* * *
12+
`$('img[usemap]').rwdImageMaps();`
1313

14-
Demo:
14+
You may also want to wrap it inside a `$(document).ready()` function, like so:
1515

16-
http://www.mattstow.com/experiment/responsive-image-maps/rwd-image-maps.html
16+
```
17+
$(document).ready(function(e) {
18+
$('img[usemap]').rwdImageMaps();
19+
});
20+
```
21+
22+
---
23+
24+
**Demo:**
25+
26+
http://www.mattstow.com/experiment/responsive-image-maps/rwd-image-maps.html
27+
28+
---
29+
30+
Copyright (c) 2012 [Matt Stow](http://mattstow.com)
31+
Licensed under the MIT license *(see [LICENSE](https://github.com/stowball/jQuery-rwdImageMaps/blob/master/LICENSE) for details)*

0 commit comments

Comments
 (0)