jsketch/README.md

37 lines
1013 B
Markdown

# jSketch
A lightweight JavaScript library for drawing facilities on an HTML5 canvas.
Conveniently wrapped in a `Sketchable` class.
Available also as a jQuery plugin.
[Demos and documentation](https://luis.leiva.name/jsketch/)
![g3 demo](figs/res-demo-g3.png)
![slm demo](figs/res-demo-slm.png)
![guessit demo](figs/res-demo-guessit.png)
![mucaptcha demo](figs/res-demo-mucaptcha.png)
![smiley demo](figs/res-demo-smiley.png)
## TL;DR:
Add `<script src="dist/sketchable.full.min.js"></script>` to your page and just do:
```js
var sketcher = new Sketchable('canvas');
```
Add `<script src="dist/jquery.sketchable.full.min.js"></script>` to your page and just do:
```js
var $sketcher = $('canvas').sketchable();
```
That's it!
**Want to know more?**
Go to [demos and documentation](https://luis.leiva.name/jsketch/).
## License
This libray is released with the [MIT license](LICENSE).
The only requirement is that you keep my copyright notice intact when you repurpose, redistribute, or reuse this code.