X-Git-Url: https://pwan.org/git/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=cc0e3d1b249d4c73c7af6cac33a920d6cfa03df8;hb=dac4c397be10fd87e87e2e8b955510375a33170b;hp=cbefbb5b9ea9dee49277816cdbcf4c1e7a204c4c;hpb=1cb9953af0f53f19c3302c198fa66b223f02a225;p=tech-radar.git diff --git a/README.md b/README.md index cbefbb5..cc0e3d1 100644 --- a/README.md +++ b/README.md @@ -1,20 +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/). + +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. Please view the file `examples/default.html` for general usages. -//TODO: give better examples. ### Contribute +[Gulp](http://gulpjs.com/) needs to be installed globally to run the project tasks. 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