X-Git-Url: https://pwan.org/git/?p=tech-radar.git;a=blobdiff_plain;f=README.md;h=cbefbb5b9ea9dee49277816cdbcf4c1e7a204c4c;hp=83f4319be18bf3d65cacffa337ebc775ad21bcf9;hb=1cb9953af0f53f19c3302c198fa66b223f02a225;hpb=297b3da3fee0bad006fef4763e5354898476ee58 diff --git a/README.md b/README.md index 83f4319..cbefbb5 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,18 @@ tech-radar A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/). -## How To Use +### How To Use -//TODO +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. -## Contribute +Please view the file `examples/default.html` for general usages. +//TODO: give better examples. -//TODO +### Contribute + +Pull Requests are welcome, write tests whenever possible. + +- clone +- `npm install` +- `bower install` +- `gulp test` - to run your tests