X-Git-Url: https://pwan.org/git/?p=tech-radar.git;a=blobdiff_plain;f=README.md;h=c1338436175fb0e5763ff391b8d728cfc6108c2a;hp=cc0e3d1b249d4c73c7af6cac33a920d6cfa03df8;hb=f44fe53f633b819c969a3894e9dc9c77ef343434;hpb=aac2a3d7605793b54d9e08dacb582b44f36c1e2b diff --git a/README.md b/README.md index cc0e3d1..c133843 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,25 @@ -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/](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 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 and maintain those dependencies. -Please view the file `examples/default.html` for general usages. +Please view the file `examples/index.html` for general usages. ### 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