1[Snap.svg](http://snapsvg.io) 2====== 3 4A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io). 5 6[Follow us on Twitter.](https://twitter.com/snapsvg) 7 8### Install 9* [Bower](http://bower.io/) - `bower install snap.svg` 10* Manual Minified - https://github.com/adobe-webplatform/Snap.svg/raw/master/dist/snap.svg-min.js 11* Manual Unminified - https://raw.githubusercontent.com/adobe-webplatform/Snap.svg/master/dist/snap.svg.js 12 13 14### Learn 15 16* [About Snap.svg](http://snapsvg.io/about/) 17* [Getting Started](http://snapsvg.io/start/) 18* [API Reference](http://snapsvg.io/docs/) 19 20### Use 21 22In your HTML file, load simply by: `<script src="snap.svg-min.js"></script>` 23No other scripts are needed. Both the minified and uncompressed (for development) versions are in the `/dist` folder. 24 25### Build 26 27Snap.svg uses [Grunt](http://gruntjs.com/) to build. 28 29* Open the terminal from the Snap.svg directory: 30 31 cd Snap.svg 32 33* Install its command line interface (CLI) globally: 34 35 npm install -g grunt-cli 36 37_*You might need to use `sudo npm`, depending on your configuration._ 38 39* Install dependencies with npm: 40 41 npm install 42 43_*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you haven’t upgraded since a lot has changed._ 44 45* Type `grunt` in the command line to build the files. 46* The results will be built into the release folder. 47* Alternatively type `grunt watch` to have the build run automatically when you make changes to source files. 48 49### Contribute 50 51* [Fill out the CLA](http://snapsvg.io/contributions/). 52* [Fork](https://help.github.com/articles/fork-a-repo) the repo. 53* Create a branch: 54 55 git checkout -b my_branch 56 57* Add your changes. 58* Commit your changes: 59 60 git commit -am "Added some awesome stuff" 61 62* Push your branch: 63 64 git push origin my_branch 65 66* Make a [pull request](https://help.github.com/articles/using-pull-requests) to `dev` branch. 67 68*Note:* Pull requests to other branches than `dev` or without filled CLA wouldn’t be accepted. 69