snapshot.js/README.md

Take a snapshot of a URL

# snapshot

Take a snapshot of a URL

## Getting Started
### On the server
Install the module with: `npm install snapshot`

```javascript
var snapshot = require('snapshot');
snapshot.awesome(); // "awesome"
```

### In the browser
Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/twolfson/snapshot/master/dist/snapshot.min.js
[max]: https://raw.github.com/twolfson/snapshot/master/dist/snapshot.js

In your web page:

```html
<script src="dist/snapshot.min.js"></script>
<script>
awesome(); // "awesome"
</script>
```

In your code, you can attach snapshot's methods to any object.

```html
<script>
this.exports = Bocoup.utils;
</script>
<script src="dist/snapshot.min.js"></script>
<script>
Bocoup.utils.awesome(); // "awesome"
</script>
```

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](http://gruntjs.com/).

_Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "lib" subdirectory!_

## Release History
_(Nothing yet)_

## License
Copyright (c) 2012 Todd Wolfson
Licensed under the MIT license.