Merge branch 'master' of ssh://pwan.org/var/www/git/projects/tech-radar

[tech-radar.git] / README.md

diff --git a/README.md b/README.md
index 83f4319..bca4844 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,33 @@
-tech-radar
-==========
+# tech-radar
 
-A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/).
 
-## How To Use
+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)
 
-//TODO
+### How To Use
 
-## Contribute
+To build a Centos 7 docker image:
 
-//TODO
+```
+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/csv.html` for the new usage, which allows the radar to be built from a CSV file.
+
+### Contribute
+
+All tasks are defined in the package.json
+Pull Requests are welcome, write tests whenever possible.
+
+- `git clone git@github.com:JudeN/tech-radar`
+- `npm install`
+- `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