README.md

   1 # tech-radar
   2
   3
   4 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)
   5
   6 ### How To Use
   7
   8 To build a Centos 7 docker image:
   9
  10 ```
  11 docker build -t "tech-radar:centos" .
  12 ```
  13
  14 To build the software from the docker image, after building the image, run the command
  15 ```
  16 docker run -it -v ${PWD}:/home/docker/tech-radar tech-radar:centos npm run build:all
  17 ```
  18
  19 Please view the file `examples/index.html` for the original general usage of the Tech Radar
  20
  21 Please view the file `examples/csv.html` for the new usage, which allows the radar to be built from a CSV file.
  22
  23 ### Contribute
  24
  25 All tasks are defined in the package.json
  26 Pull Requests are welcome, write tests whenever possible.
  27
  28 - `git clone git@github.com:JudeN/tech-radar`
  29 - `npm install`
  30 - `npm test` - to run your tests
  31 - `npm run build` - to build out your changes
  32 - `npm run examples` - to generate the examples
  33 - `npm run test:dist` - make sure uglify doesn't break stuff