X-Git-Url: https://pwan.org/git/?p=tech-radar.git;a=blobdiff_plain;f=README.md;h=bca484489e394701c6eb26c90938120671025e60;hp=3c0d893487f292209e12675bc8610a69d2291145;hb=e7cb5912f51edec67155095a1cf9ca5c236e9a06;hpb=8aa70263312ce3aaffcdd7705fc439b3c4f941a6 diff --git a/README.md b/README.md index 3c0d893..bca4844 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,31 @@ -# tech-radar [![Build Status](https://snap-ci.com/Trecenti/tech-radar/branch/master/build_image)](https://snap-ci.com/Trecenti/tech-radar/branch/master) -[![NPM](https://nodei.co/npm/tech-radar.png)](https://nodei.co/npm/tech-radar/) +# tech-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/) +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 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: +To build a Centos 7 docker image: ``` docker build -t "tech-radar:centos" . ``` -To connect to the docker image after it was built: +To build the software from the docker image, after building the image, run the command ``` -docker run -it tech-radar:centos /bin/bash +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:Trecenti/tech-radar` +- `git clone git@github.com:JudeN/tech-radar` - `npm install` - `npm test` - to run your tests - `npm run build` - to build out your changes