From 3463a66acea64df40b6515d7bb18be7472a0e56a Mon Sep 17 00:00:00 2001 From: Dmitry Baranovskiy Date: Fri, 3 Feb 2017 12:48:28 +1100 Subject: [PATCH] Updated README with badges --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 055f57b..087a9cc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[Snap.svg](http://snapsvg.io) +[Snap.svg](http://snapsvg.io) · [![npm version](https://img.shields.io/npm/v/snapsvg.svg?style=flat)](https://www.npmjs.com/package/snapsvg) [![Build Status](https://travis-ci.org/adobe-webplatform/Snap.svg.svg?branch=dev)](https://travis-ci.org/adobe-webplatform/Snap.svg) [![Downloads](https://img.shields.io/npm/dt/snapsvg.svg)](https://www.npmjs.com/package/snapsvg) [![CDNJS](https://img.shields.io/cdnjs/v/snap.svg.svg)](https://cdnjs.com/libraries/snap.svg/) [![GitHub Tag](https://img.shields.io/github/tag/adobe-webplatform/snap.svg.svg)](https://github.com/adobe-webplatform/Snap.svg/releases) [![License](https://img.shields.io/npm/l/snapsvg.svg)](https://github.com/adobe-webplatform/Snap.svg/blob/master/LICENSE) ====== A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io). @@ -51,10 +51,22 @@ 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. +* 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. +### Testing + +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](http://phantomjs.org) and run command +```sh +grunt test +``` + ### Contribute * [Fill out the CLA](http://snapsvg.io/contributions/). @@ -64,6 +76,7 @@ _*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting git checkout -b my_branch ``` * Add your changes. +* Check that tests are passing * Commit your changes: ```sh git commit -am "Added some awesome stuff"