From 9900a5c17fe7207cfcbe6997ad7d0fbb24306f14 Mon Sep 17 00:00:00 2001 From: Bruno Trecenti Date: Wed, 20 May 2015 17:14:44 -0300 Subject: [PATCH] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ef4f738..11e0b32 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,16 @@ Check the example [here](http://brunotrecenti.com/tech-radar/) 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. -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 -- 2.39.2