X-Git-Url: https://pwan.org/git/?a=blobdiff_plain;f=README.md;h=3c0d893487f292209e12675bc8610a69d2291145;hb=8aa70263312ce3aaffcdd7705fc439b3c4f941a6;hp=6f3fc0d003e4c8e36ee7cb76bcf06c17d8a303cc;hpb=adb8096fd9f87cb35a3e4c750538d3df2b3a5ed0;p=tech-radar.git

diff --git a/README.md b/README.md
index 6f3fc0d..3c0d893 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,38 @@
-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 three dependencies [d3](http://d3js.org/), [d3-queue](https://github.com/d3/d3-queue) 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/index.html` for general usages.
+
+### Docker support
+
+To build a centos-based docker image:
+
+```
+docker build -t "tech-radar:centos" .
+```
 
-Please view the file `examples/default.html` for general usages.
-//TODO: give better examples.
+To connect to the docker image after it was built:
+```
+docker run -it tech-radar:centos /bin/bash
+```
 
 ### Contribute
 
+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