Permalink
Browse files

Added better instructions and MIT license

  • Loading branch information...
1 parent 13ec7dc commit ad30d62c74b670026678e6391b174f507a32df3a @stowball committed Jul 17, 2013
Showing with 43 additions and 8 deletions.
  1. +20 −0 LICENSE
  2. +23 −8 README.md
View
20 LICENSE
@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Izilla Partners Pty Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,16 +1,31 @@
-jQuery RWD Image Maps
-==============================
+# jQuery RWD Image Maps
### 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
-* * *
+---
-Usage:
+**Usage:**
-$('img[usemap]').rwdImageMaps();
+* Add a link to jQuery in your page, preferably at the bottom just before the closing `</body>`
+* After jQuery, either in a `<script>` block or a separate file, call:
-* * *
+`$('img[usemap]').rwdImageMaps();`
-Demo:
+You may also want to wrap it inside a `$(document).ready()` function, like so:
-http://www.mattstow.com/experiment/responsive-image-maps/rwd-image-maps.html
+```
+$(document).ready(function(e) {
+ $('img[usemap]').rwdImageMaps();
+});
+```
+
+---
+
+**Demo:**
+
+http://www.mattstow.com/experiment/responsive-image-maps/rwd-image-maps.html
+
+---
+
+Copyright (c) 2012 [Matt Stow](http://mattstow.com)
+Licensed under the MIT license *(see [LICENSE](https://github.com/stowball/jQuery-rwdImageMaps/blob/master/LICENSE) for details)*

0 comments on commit ad30d62

Please sign in to comment.