From 1cb9953af0f53f19c3302c198fa66b223f02a225 Mon Sep 17 00:00:00 2001 From: trecenti Date: Tue, 18 Mar 2014 19:09:57 -0300 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) 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 -- 2.39.2