snap.js/README.md

69 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

[Snap.svg](http://snapsvg.io)
======
A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io).
[Follow us on Twitter.](https://twitter.com/snapsvg)
### Install
* [Bower](http://bower.io/) - `bower install snap.svg`
* Manual Minified - https://github.com/adobe-webplatform/Snap.svg/raw/master/dist/snap.svg-min.js
* Manual Unminified - https://raw.githubusercontent.com/adobe-webplatform/Snap.svg/master/dist/snap.svg.js
### Learn
* [About Snap.svg](http://snapsvg.io/about/)
* [Getting Started](http://snapsvg.io/start/)
* [API Reference](http://snapsvg.io/docs/)
### Use
In your HTML file, load simply by: `<script src="snap.svg-min.js"></script>`
No other scripts are needed. Both the minified and uncompressed (for development) versions are in the `/dist` folder.
### Build
Snap.svg uses [Grunt](http://gruntjs.com/) to build.
* Open the terminal from the Snap.svg directory:
cd Snap.svg
* Install its command line interface (CLI) globally:
npm install -g grunt-cli
_*You might need to use `sudo npm`, depending on your configuration._
* Install dependencies with npm:
npm install
_*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you havent upgraded since a lot has changed._
* Type `grunt` in the command line to build the files.
* The results will be built into the release folder.
* Alternatively type `grunt watch` to have the build run automatically when you make changes to source files.
### Contribute
* [Fill out the CLA](http://snapsvg.io/contributions/).
* [Fork](https://help.github.com/articles/fork-a-repo) the repo.
* Create a branch:
git checkout -b my_branch
* Add your changes.
* Commit your changes:
git commit -am "Added some awesome stuff"
* Push your branch:
git push origin my_branch
* Make a [pull request](https://help.github.com/articles/using-pull-requests) to `dev` branch.
*Note:* Pull requests to other branches than `dev` or without filled CLA wouldnt be accepted.