Permalink
Browse files

'Added license and improved readme'

  • Loading branch information...
1 parent 903e4c0 commit e72b8366e8811768b637daaa8513d4d5044bce57 @jamesbloomer committed Feb 14, 2012
Showing with 56 additions and 5 deletions.
  1. +22 −0 LICENSE
  2. +34 −4 README.md
  3. +0 −1 bin/tadaa
View
22 LICENSE
@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 James Bloomer <https://github.com/jamesbloomer>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,5 +1,35 @@
-# Tadaa #
+# Tadaa
-Monitoring via audio.
-Sounds for your metrics.
-Play sounds depending on whether a counter you are monitoring goes up and down.
+Monitor stuff via the medium of sound.
+
+## Install
+
+ $ npm install tadaa
+
+## Requirements
+
+Tadaa assumes that 'aplay' is executable available on the system (mostly true for Linux systems).
+
+## Usage
+
+Tada can play an up or a down sound, depending on whether the value you are monitoring goes up or down.
+
+ var tadaa = require('tadaa');
+ var interval = 60000; // time in ms for which the value function is called
+ var up = 'up.wav'; // sound to play when value goes up
+ var down = 'down.wav'; // sound to play when value goes down
+
+ // Function to call to get the value
+ var getValue = function(callback){
+ // ...my clever value logic...
+ callback(null, Math.random() * 100); }
+
+ tadaa.start(interval, up, down, getValue};
+
+## Examples
+
+Use Tadaa to:
+- Play a sound when a bug is raised or closed in your bug tracking system
+- Play a sound when a story is finished
+- Play a sound when your favourite team scores / conceeds.
+- etc...
View
@@ -11,5 +11,4 @@ program
.option('-d, --down [down]', 'The sound to play when the monitored value goes down')
.parse(process.argv);
-// TODO switch in some useful value checkers
tadaa.start(program.interval, program.up, program.down, pivotaltracker.getOpenBugs};

0 comments on commit e72b836

Please sign in to comment.