New CSV-based example

[tech-radar.git] / README.md

diff --git a/README.md b/README.md
index 1563c0c..c133843 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# tech-radar [![Build Status](https://travis-ci.org/Trecenti/tech-radar.svg?branch=master)](https://travis-ci.org/Trecenti/tech-radar)
+# tech-radar [![Build Status](https://snap-ci.com/Trecenti/tech-radar/branch/master/build_image)](https://snap-ci.com/Trecenti/tech-radar/branch/master)
 [![NPM](https://nodei.co/npm/tech-radar.png)](https://nodei.co/npm/tech-radar/)
 
 
@@ -8,16 +8,18 @@ Check the example [here](http://brunotrecenti.com/tech-radar/)
 
 ### How To Use
 
-The package has two dependencies [d3](http://d3js.org/) and [chancejs](http://chancejs.com/) that needs to be loaded separatedely for now, in the future there's a plan to add maintain these dependencies.
+The package has two dependencies [d3](http://d3js.org/) and [chancejs](http://chancejs.com/) that needs to be loaded separatedely for now, in the future there's a plan to add and maintain those dependencies.
 
-Please view the file `examples/default.html` for general usages.
+Please view the file `examples/index.html` for general usages.
 
 ### Contribute
 
-[Gulp](http://gulpjs.com/) needs to be installed globally to run the project tasks.
+All tasks are defined in the package.json
 Pull Requests are welcome, write tests whenever possible.
 
 - `git clone git@github.com:Trecenti/tech-radar`
 - `npm install`
-- `bower install`
-- `gulp test` - to run your tests
+- `npm test` - to run your tests
+- `npm run build` - to build out your changes
+- `npm run examples` - to generate the examples
+- `npm run test:dist` - make sure uglify doesn't break stuff