README.md

   1 tech-radar
   2 ==========
   3
   4 A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/).
   5
   6 ### How To Use
   7
   8 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.
   9
  10 Please view the file `examples/default.html` for general usages.
  11 //TODO: give better examples.
  12
  13 ### Contribute
  14
  15 [Gulp](http://gulpjs.com/) needs to be installed globally to run the project tasks.
  16 Pull Requests are welcome, write tests whenever possible.
  17
  18 - `git clone git@github.com:Trecenti/tech-radar`
  19 - `npm install`
  20 - `bower install`
  21 - `gulp test` - to run your tests