X-Git-Url: https://pwan.org/git/?p=tech-radar.git;a=blobdiff_plain;f=README.md;h=bca484489e394701c6eb26c90938120671025e60;hp=4b3c5c4fca55efd1071e2a377a7fc8d91b180668;hb=HEAD;hpb=0365e6a86eb109218424cd7e2adf7ebf89e1baa1

diff --git a/README.md b/README.md
index 4b3c5c4..bca4844 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,33 @@
-tech-radar
-==========
+# tech-radar
 
-A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/).
+
+A library that supports the creation of a Tech Radar, inspired by [thoughtworks.com/radar/](http://thoughtworks.com/radar/) and [https://github.com/trecenti/tech-radar](https://github.com/trecenti/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.
+To build a Centos 7 docker image:
+
+```
+docker build -t "tech-radar:centos" .
+```
+
+To build the software from the docker image, after building the image, run the command
+```
+docker run -it -v ${PWD}:/home/docker/tech-radar tech-radar:centos npm run build:all
+```
+
+Please view the file `examples/index.html` for the original general usage of the Tech Radar 
 
-Please view the file `examples/default.html` for general usages.
-//TODO: give better examples.
+Please view the file `examples/csv.html` for the new usage, which allows the radar to be built from a CSV file.
 
 ### Contribute
 
-[Gulp](http://gulpjs.com/) needs to be installed globally to run the project tasks.
+All tasks are defined in the package.json
 Pull Requests are welcome, write tests whenever possible.
 
-- `git clone git@github.com:Trecenti/tech-radar`
+- `git clone git@github.com:JudeN/tech-radar`
 - `npm install`
-- `bower install`
-- `gulp test` - to run your tests
+- `npm test` - to run your tests
+- `npm run build` - to build out your changes
+- `npm run examples` - to generate the examples
+- `npm run test:dist` - make sure uglify doesn't break stuff