r2d2 - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "r2d2",
-  "version": "0.0.2",
-  "description": "node test with play-sound",
+  "version": "0.0.3",
+  "description": "Plays a random sound as a notification from console or cli",
   "main": "index.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

 # r2d2
-node test with play-sound
+Sound notifier
+
+## Description
+
+Plays a random sound (mp3,ogg) as a notification from console or cli
+
+## Install
+```bash
+npm install r2d2 --save
+```
+
+## Usage
+
+Create an instance and call `headsUp()`:
+```javascript
+var notifier = require('r2d2')();
+
+notifier.headsUp(function(err){
+  if(err) {
+    console.error('Error: couldn\'t play sound because:');
+    console.error(err.stack);
+  }
+  console.log('You\'ve been notified');
+});
+```
+
+## API
+### headsUp([callback])
+Plays a random sound and executes callback. Callback signature is `(err)` (aka *thunk*)
+
+
+Just for fun and testing

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

63668

increased by0.93%

Number of lines in readme file

34

increased by1033.33%

No dependency changes