Permalink
Browse files

Update readme

  • Loading branch information...
1 parent 50c3d4b commit 5d739e52eb0dd31d1eabcf2acb79dd0398ab2763 @m-allanson committed Apr 17, 2012
Showing with 26 additions and 3 deletions.
  1. +26 −3 README
View
29 README
@@ -1,5 +1,28 @@
-A javascript script for quickly overlaying an image over a page. Intended to be an update to http://code.google.com/p/jsgridoverlay/
+### What is it?
+It's a javascript script for quickly overlaying an image onto a page. You can adjust the transparency if you like, which makes it handy for comparing a page to an existing layout. Made out of plain old javascript so doesn't have any dependencies or require any other libraries.### How does it work?
-Include the script at the bottom of your page. Press Ctrl + ; to activate. Drag an image from your machine to the page to load it in. Then toggle with Ctrl + ; or adjust opacity with Ctrl + [ and Ctrl + ].
+Include the following line at the bottom of your page:
-Try it out on the demo page: http://m-allanson.github.com/jsgridoverlay/
+`<script type=\"text/javascript\" src=\"https://raw.github.com/m-allanson/jsgridoverlay/master/grid.js\"></script>`
+
+
+Once installed, add an image like this:
+
+* Press `Ctrl + ;` to activate a blank overlay.
+* Drag an image from your computer and drop it on the blank overlay.
+
+
+Then make adjustments with these shortcuts:
+
+* Toggle with `Ctrl + ;`
+* Adjust opacity with `Ctrl + [` and `Ctrl + ]`.
+
+### Where do I get it?
+
+Right here on GitHub: [https://github.com/m-allanson/jsgridoverlay](https://github.com/m-allanson/jsgridoverlay)
+
+### Anything else?
+
+This script is originally based on the jQuery plugin [jsgridoverlay](http://code.google.com/p/jsgridoverlay/), written by [jeddy3](https://github.com/jeddy3), [thegingerbloke](https://github.com/thegingerbloke) and [m-allanson](https://github.com/m-allanson)
+
+This script is also a bit of an experiment, makes no attempt to support older browsers and has had minimal amounts of testing (unlike the original version linked above). However any suggestions for improvements are welcome!","tagline":"A standalone javascript script to overlay an image onto a webpage.

0 comments on commit 5d739e5

Please sign in to comment.