From 1cb9953af0f53f19c3302c198fa66b223f02a225 Mon Sep 17 00:00:00 2001 From: trecenti Date: Tue, 18 Mar 2014 19:09:57 -0300 Subject: [PATCH 1/6] 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 From adb8096fd9f87cb35a3e4c750538d3df2b3a5ed0 Mon Sep 17 00:00:00 2001 From: trecenti Date: Tue, 18 Mar 2014 19:10:57 -0300 Subject: [PATCH 2/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cbefbb5..6f3fc0d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Please view the file `examples/default.html` for general usages. 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 From 0365e6a86eb109218424cd7e2adf7ebf89e1baa1 Mon Sep 17 00:00:00 2001 From: trecenti Date: Tue, 18 Mar 2014 19:12:19 -0300 Subject: [PATCH 3/6] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6f3fc0d..4b3c5c4 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ 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 git@github.com:Trecenti/tech-radar` From 8584b04dbc1de9c794fdb85e3f210e95d147e0f1 Mon Sep 17 00:00:00 2001 From: trecenti Date: Tue, 18 Mar 2014 19:13:04 -0300 Subject: [PATCH 4/6] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 4b3c5c4..10fa50d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.c 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 From 9cb1d2beeafe45770c0396a560522ca7f3f76e66 Mon Sep 17 00:00:00 2001 From: trecenti Date: Tue, 18 Mar 2014 19:26:13 -0300 Subject: [PATCH 5/6] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 10fa50d..c5a4d14 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ tech-radar A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](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. From 4a3d835a411c9d499a300864cac7818028a7d8c2 Mon Sep 17 00:00:00 2001 From: Dave King Date: Tue, 18 Mar 2014 18:31:26 -0400 Subject: [PATCH 6/6] Fix link in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c5a4d14..cc0e3d1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ 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/)