bob-builder

bob

About

Bob is the FED saviour

Consuming

To consume this repo you will need to install it globally, this makes it accessable from anywhere

$ npm install -g

Developing on

If you want to work on this repo you will need to install the dependencies

$ npm install

You will also want to link the repo with npm. This means you won't need to run npm install -g every time you make a change.

$ npm link

EditorConfig

EditorConfig helps us define and maintain consistent coding styles between different editors and IDEs. If you are using Sublime Editor you can install the EditorConfig using Package Control.

For non Sublime development a bunch of other IDE plugins are available here

Documentation

Visit our bitbucket website for all the things.

Notes on coding style

Code is linted by ".jshintrc" and checked against the coding style guide "shortbreaks.jscs.json" when you run the default grunt task:

$ grunt

Tests

Tests will run using the default grunt task but can also be called stand-alone using:

$ grunt test

License

Copyright (c) YYYY Shortbreaks Licensed under the MIT license.