snapsvg

Snap.svg ·    
======

A JavaScript SVG library for the modern web. Learn more at snapsvg.io.

Follow us on Twitter.

$3

* Bower - bower install snap.svg !Bower
* npm - npm install snapsvg  
* 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

$3

* About Snap.svg
* Getting Started
* API Reference
* Slack Room. Invite

$3

In your HTML file, load simply by:
``html

`
No other scripts are needed. Both the minified and uncompressed (for development) versions are in the /dist folder.

To load with webpack use following command:
`js
const Snap = require(imports-loader?this=>window,fix=>module.exports=0!snapsvg/dist/snap.svg.js);
`

$3


Snap.svg uses Grunt to build.

* Open the terminal from the Snap.svg directory:
`sh
cd Snap.svg
`
* Install its command line interface (CLI) globally:
`sh
npm install -g grunt-cli
`
_*You might need to use sudo npm, depending on your configuration._

* Install dependencies with npm:
`sh
npm install
`
_*Snap.svg uses Grunt 0.4.0. You might want to read more on their website if you haven’t upgraded since a lot has changed._

* To build the files run
`sh
grunt
`
* The results will be built into the dist folder.
* Alternatively type grunt watch to have the build run automatically when you make changes to source files.

$3

Tests are located in test folder. To run tests, simply open test.html in there. Automatic tests use PhantomJS to scrap this file, so you can use it as a reference.

Alternatively, install PhantomJS and run command
`sh
grunt test
`

$3

* Fill out the CLA.
* Fork the repo.
* Create a branch:
`sh
git checkout -b my_branch
`
* Add your changes.
* Check that tests are passing
* Commit your changes:
`sh
git commit -am "Added some awesome stuff"
`
* Push your branch:
`sh
git push origin my_branch
`
* Make a pull request to dev(!) branch.

Note: Pull requests to other branches than dev` or without filled CLA wouldn’t be accepted.