Skip to content

Commit

Permalink
overhauled the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bengt committed Oct 11, 2012
1 parent 6bc36d4 commit f2cc1b2
Showing 1 changed file with 37 additions and 17 deletions.
54 changes: 37 additions & 17 deletions README.md
@@ -1,6 +1,13 @@
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.

## Dependencies

- [jQuery](https://github.com/jquery/jquery)

## Example Usage

#### Here's an example:
````javascript
$('body').noisy({
intensity: 0.9,
Expand All @@ -11,42 +18,55 @@ $('body').noisy({
});
````


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/).
## Demo

You can try the [interactive demo](http://rappdaniel.com/other/noisy-sample/).

Installation
----
Just download the repository and link to the local minimized script
## Installation

Just download the repository and link to the local minimized script:

````html
<script src="noisy/jquery/jquery.noisy.min.js"></script>
````

Or link via [cdnjs.com](http://cdnjs.com)
Alternatively, include it from [cdnjs.com](http://cdnjs.com):

````html
<script src="http://cdnjs.cloudflare.com/ajax/libs/noisy/1.1/jquery.noisy.min.js"></script>
````

## Rationale

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.

#### 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.
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.

## Contact

If you have any questions or suggestions that don't fit GitHub, send them to [@DanielRapp](http://twitter.com/DanielRapp)

## Supporting

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 f2cc1b2

Please sign in to comment.