Update README.md
authorBruno Trecenti <bruno.lopestrecenti@gmail.com>
Wed, 20 May 2015 20:14:44 +0000 (17:14 -0300)
committerBruno Trecenti <bruno.lopestrecenti@gmail.com>
Wed, 20 May 2015 20:14:44 +0000 (17:14 -0300)
README.md

index ef4f738..11e0b32 100644 (file)
--- 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