-tech-radar
-==========
+# tech-radar [](https://snap-ci.com/Trecenti/tech-radar/branch/master)
+[](https://nodei.co/npm/tech-radar/)
-A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](http://thoughtworks.com/radar/).
+
+A library that supports the creation of a Tech Radar, inspired by [thoughtworks.com/radar/](http://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.
+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.
+
+Please view the file `examples/index.html` for general usages.
+
+### Docker support
+
+To build a centos-based docker image:
+
+```
+docker build -t "tech-radar:centos" .
+```
-Please view the file `examples/default.html` for general usages.
+To connect to the docker image after it was built:
+```
+docker run -it tech-radar:centos /bin/bash
+```
### 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`
- `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
projects / tech-radar.git / blobdiff