From: Bruno Trecenti <btrecent@thoughtworks.com>
Date: Fri, 21 Mar 2014 19:53:03 +0000 (-0300)
Subject: Merge branch 'master' of github.com:Trecenti/tech-radar
X-Git-Url: https://pwan.org/git/?p=tech-radar.git;a=commitdiff_plain;h=9bc27c381030f455ff559ca0754faaee7c0ffc09;hp=85a8617136aea96b780c0dbecb40e718cd62bcc7

Merge branch 'master' of github.com:Trecenti/tech-radar
---

diff --git a/README.md b/README.md
index 83f4319..cc0e3d1 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,22 @@
 tech-radar
 ==========
 
-A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/).
+A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](http://thoughtworks.com/radar/).
 
-## How To Use
+Check the example [here](http://brunotrecenti.com/tech-radar/)
 
-//TODO
+### How To Use
 
-## Contribute
+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.
 
-//TODO
+Please view the file `examples/default.html` for general usages.
+
+### Contribute
+
+[Gulp](http://gulpjs.com/) needs to be installed globally to run the project tasks.
+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