Permalink
Browse files

Merge pull request #21 from bigben87/new_readme

New readme
  • Loading branch information...
2 parents 6bc36d4 + 99cf5b7 commit d0014a5ed7124026bb0f4feb3b849fe6ee12f193 @DanielRapp committed Oct 11, 2012
Showing with 49 additions and 27 deletions.
  1. +49 −27 README.md
View
@@ -1,52 +1,74 @@
-Noisy is a jQuery plugin that adds random noise to a given element.
+# Noisy
+
+A jQuery plugin that adds random noise to the background of an element.
+
+## Demo
+
+You can try the [interactive demo](http://rappdaniel.com/other/noisy-sample/).
+
+## Dependency
+
+- [jQuery](https://github.com/jquery/jquery)
+
+## Install
+
+Just download the repository and link to the local minimized script:
+
+````html
+<script src="noisy/jquery/jquery.noisy.min.js"></script>
+````
+
+Alternatively, include it from [cdnjs.com](http://cdnjs.com):
+
+````html
+<script src="//cdnjs.cloudflare.com/ajax/libs/noisy/1.1/jquery.noisy.min.js"></script>
+````
+
+## Usage
+
+An example showing all parameters would be the following:
-#### Here's an example:
````javascript
$('body').noisy({
- intensity: 0.9,
- size: 200,
+ intensity: 0.9,
+ size: 200,
opacity: 0.08,
fallback: 'fallback.png',
monochrome: false
});
````
-
But since all parameters are optional you can just use it like this:
````javascript
$('body').noisy();
````
-You can try the interactive demo [here](http://rappdaniel.com/other/noisy-sample/).
+## Rationale
-Installation
-----
-Just download the repository and link to the local minimized script
-
-````html
-<script src="noisy/jquery/jquery.noisy.min.js"></script>
-````
+What's wrong with using an image?
-Or link via [cdnjs.com](http://cdnjs.com)
+1. Bandwidth cost
+ Due to the random nature of background images with a noisy overlay,
+ compression usually isn't very effective. With this 1 KB script you can
+ generate images up to 300 KB without loading for even a second. Saving
+ bandwidth costs and loading time.
+2. Development speed
+ Trying out an image with a different noise opacity involves a much smaller
+ amount of steps by just updating a parameter than changing and saving the
+ image in Photoshop.
+3. Flexibility
+ By generating the background image in javascript, one does not need to rely
+ on the webserver being able to serve static files for it. With generated
+ favicons etc. a static files serving webserver becomes optional.
-````html
-<script src="http://cdnjs.cloudflare.com/ajax/libs/noisy/1.1/jquery.noisy.min.js"></script>
-````
+## Contact
-What's wrong with using an image?
-----
-#### Bandwidth cost
-Due to the random nature of background images with a noisy overlay, compression usually isn't very effective. With this 1 KB script you can generate images up to 300 KB without loading for even a second. Saving bandwidth costs and loading time.
+If you have any questions or suggestions that don't fit GitHub, send them to [@DanielRapp](http://twitter.com/DanielRapp)
-#### Development speed
-Trying out an image with a different noise opacity involves a much smaller amount of steps by just updating a parameter than changing and saving the image in Photoshop.
+## Support
-Contact
-----
I'd be flattered if you'd flattr this :)
[![Flattr this](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/143004/jQuery-noise-generator)
-
-If you have any questions or suggestions that doesn't fit GitHub, send them to [@DanielRapp](http://twitter.com/DanielRapp)

0 comments on commit d0014a5

Please sign in to comment.