snap.js/README.md

[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 haven’t 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 wouldn’t be accepted.
-												Updates to README and code sample for Snap.animate

											
										
										
											2013-10-15 20:20:01 +00:00
+								[Snap.svg](http://snapsvg.io)
-												Initial commit

											
										
										
											2013-07-05 04:56:18 +00:00
+								======
-												Fixed some text. Added a link.

											
										
										
											2013-10-22 17:23:59 +00:00
+								A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io).
-												Added API Reference in TopCaoat style

											
										
										
											2013-09-02 04:26:51 +00:00
-												Added a twitter link.

											
										
										
											2013-10-23 14:56:38 +00:00
+								[Follow us on Twitter.](https://twitter.com/snapsvg)
-												Updated README with instructions for installation either through Bower or manually

											
										
										
											2014-04-23 17:47:27 +00:00
+								### 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
-												Added some additional links

											
										
										
											2013-10-23 13:53:40 +00:00
+								### Learn
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Added some additional links

											
										
										
											2013-10-23 13:53:40 +00:00
+								* [About Snap.svg](http://snapsvg.io/about/)
 								* [Getting Started](http://snapsvg.io/start/)
-												Fixed typo in README

											
										
										
											2013-10-24 01:01:42 +00:00
+								* [API Reference](http://snapsvg.io/docs/)
-												Added some additional links

											
										
										
											2013-10-23 13:53:40 +00:00
-												Moved docs from dist/ to doc/

											
										
										
											2013-10-29 01:13:58 +00:00
+								### 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.
-												Added some additional links

											
										
										
											2013-10-23 13:53:40 +00:00
+								### Build
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Fixed some text. Added a link.

											
										
										
											2013-10-22 17:23:59 +00:00
+								Snap.svg uses [Grunt](http://gruntjs.com/) to build.
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Fixed some text. Added a link.

											
										
										
											2013-10-22 17:23:59 +00:00
+								* Open the terminal from the Snap.svg directory:
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Type in README

											
										
										
											2013-10-14 12:40:21 +00:00
+								        cd Snap.svg
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Fixed some text. Added a link.

											
										
										
											2013-10-22 17:23:59 +00:00
+								* Install its command line interface (CLI) globally:
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
 								        npm install -g grunt-cli
-												Updates to README and code sample for Snap.animate

											
										
										
											2013-10-15 20:20:01 +00:00
+								_*You might need to use `sudo npm`, depending on your configuration._
-												Fixed some text. Added a link.

											
										
										
											2013-10-22 17:23:59 +00:00
+								* Install dependencies with npm:
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
 								        npm install
-												Change name to Snap.svg. Added dr.js to grunt via grunt-exec

											
										
										
											2013-09-25 05:52:57 +00:00
+								_*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._
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
 								* Type `grunt` in the command line to build the files.
 								* The results will be built into the release folder.
-												Update README.md

Added Contributing section
											
										
										
											2013-10-15 17:21:01 +00:00
+								* Alternatively type `grunt watch` to have the build run automatically when you make changes to source files.
-												Added some additional links

											
										
										
											2013-10-23 13:53:40 +00:00
+								### Contribute
-												Update README.md

Added Contributing section
											
										
										
											2013-10-15 17:21:01 +00:00
-												Fixed CLA link

											
										
										
											2013-10-23 20:53:23 +00:00
+								* [Fill out the CLA](http://snapsvg.io/contributions/).
-												Edited copy

											
										
										
											2013-10-16 21:42:11 +00:00
+								* [Fork](https://help.github.com/articles/fork-a-repo) the repo.
 								* Create a branch:
-												Update README.md

Added Contributing section
											
										
										
											2013-10-15 17:21:01 +00:00
 								        git checkout -b my_branch
-												Edited copy

											
										
										
											2013-10-16 21:42:11 +00:00
+								* Add your changes.
 								* Commit your changes:
-												Update README.md

Added Contributing section
											
										
										
											2013-10-15 17:21:01 +00:00
 								        git commit -am "Added some awesome stuff"
-												Edited copy

											
										
										
											2013-10-16 21:42:11 +00:00
+								* Push your branch:
-												Update README.md

Added Contributing section
											
										
										
											2013-10-15 17:21:01 +00:00
 								        git push origin my_branch
-												Added statement regarding DEV branch into README

											
										
										
											2013-10-25 20:54:02 +00:00
+								* 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 wouldn’t be accepted.