Updating README.md
authorJude N <juden@pwan.org>
Mon, 29 May 2017 18:49:49 +0000 (14:49 -0400)
committerJude N <juden@pwan.org>
Mon, 29 May 2017 18:49:49 +0000 (14:49 -0400)
Dockerfile
README.md

index 4d19dda..a6b0c0e 100644 (file)
@@ -13,7 +13,3 @@ RUN yum update -y && \
     echo "To build tech-radar, run this docker image with this command:"
     echo "docker run -it -v ${PWD}:/home/docker/tech-radar tech-radar:centos npm run build:all"
 
-#    cd /home/docker/tech-radar &&\
-#    npm install &&\
-#    npm run build && \
-#    npm run examples;
index 3c0d893..bca4844 100644 (file)
--- 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