Skip to content

Commit

Permalink
Merge branch 'master' of github.com:Trecenti/tech-radar
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno Trecenti committed Mar 21, 2014
2 parents 85a8617 + aac2a3d commit 9bc27c3
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]:Trecenti/tech-radar`
- `npm install`
- `bower install`
- `gulp test` - to run your tests

0 comments on commit 9bc27c3

Please sign in to comment.