-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:Trecenti/tech-radar
- Loading branch information
Showing
1 changed file
with
15 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |