Permalink
Browse files

Add doco.

  • Loading branch information...
1 parent fca0ac7 commit d98af42e79f162c09554175fe4f44f449c64338e @cliffano committed Apr 2, 2013
Showing with 10 additions and 0 deletions.
  1. +10 −0 lib/ninjablocks.js
View
@@ -1,10 +1,20 @@
var _ = require('underscore'),
ninjaBlocks = require('ninja-blocks');
+/**
+ * class NinjaBlocks
+ *
+ * @param {String} token: Ninja Blocks API Access Token https://a.ninja.is/hacking
+ */
function NinjaBlocks(token) {
this.token = token;
}
+/**
+ * Notify build status as a colour on RGB LED device (the eyes on Ninja Blocks).
+ *
+ * @param {String} status: build status
+ */
NinjaBlocks.prototype.notify = function (status) {
const COLOURS = {
OK: '00FF00',

0 comments on commit d98af42

Please sign in to comment.