X-Git-Url: https://pwan.org/git/?p=tech-radar.git;a=blobdiff_plain;f=README.md;h=c1338436175fb0e5763ff391b8d728cfc6108c2a;hp=cbefbb5b9ea9dee49277816cdbcf4c1e7a204c4c;hb=f44fe53f633b819c969a3894e9dc9c77ef343434;hpb=1cb9953af0f53f19c3302c198fa66b223f02a225

diff --git a/README.md b/README.md
index cbefbb5..c133843 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,25 @@
-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/)
 
-A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/).
+
+A library that supports the creation of a Tech Radar, inspired by [thoughtworks.com/radar/](http://thoughtworks.com/radar/).
+
+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.
-//TODO: give better examples.
+Please view the file `examples/index.html` for general usages.
 
 ### Contribute
 
+All tasks are defined in the package.json
 Pull Requests are welcome, write tests whenever possible.
 
-- clone
+- `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