README.md

   1 # tech-radar [![Build Status](https://snap-ci.com/Trecenti/tech-radar/branch/master/build_image)](https://snap-ci.com/Trecenti/tech-radar/branch/master)
   2 [![NPM](https://nodei.co/npm/tech-radar.png)](https://nodei.co/npm/tech-radar/)
   3
   4
   5 A library that supports the creation of a Tech Radar, inspired by [thoughtworks.com/radar/](http://thoughtworks.com/radar/).
   6
   7 Check the example [here](http://brunotrecenti.com/tech-radar/)
   8
   9 ### How To Use
  10
  11 The package has three dependencies [d3](http://d3js.org/), [d3-queue](https://github.com/d3/d3-queue) and [chancejs](http://chancejs.com/) that needs to be loaded separatedely for now, in the future there's a plan to add and maintain those dependencies.
  12
  13 Please view the file `examples/index.html` for general usages.
  14
  15 ### Docker support
  16
  17 To build a centos-based docker image:
  18
  19 ```
  20 docker build -t "tech-radar:centos" .
  21 ```
  22
  23 To connect to the docker image after it was built:
  24 ```
  25 docker run -it tech-radar:centos /bin/bash
  26 ```
  27
  28 ### Contribute
  29
  30 All tasks are defined in the package.json
  31 Pull Requests are welcome, write tests whenever possible.
  32
  33 - `git clone git@github.com:Trecenti/tech-radar`
  34 - `npm install`
  35 - `npm test` - to run your tests
  36 - `npm run build` - to build out your changes
  37 - `npm run examples` - to generate the examples
  38 - `npm run test:dist` - make sure uglify doesn't break stuff