Adding Dockerfile / removing bower

[tech-radar.git] / README.md

diff --git a/README.md b/README.md
index 83f4319..3c0d893 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,38 @@
-tech-radar
-==========
+# 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/)
 
-A library that allows the creationg of a Tech Radar, inspired by [thoughtworks.com/radar/](thoughtworks.com/radar/).
 
-## How To Use
+A library that supports the creation of a Tech Radar, inspired by [thoughtworks.com/radar/](http://thoughtworks.com/radar/).
 
-//TODO
+Check the example [here](http://brunotrecenti.com/tech-radar/)
 
-## Contribute
+### How To Use
 
-//TODO
+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" .
+```
+
+To connect to the docker image after it was built:
+```
+docker run -it tech-radar:centos /bin/bash
+```
+
+### 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`
+- `npm install`
+- `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