Create README.md

williamoliveira · May 7, 2016 · 7d438f1 · 7d438f1
1 parent f6b0a75
commit 7d438f1
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# SoundNotificationWebpackPluginn
+Very simple webpack plugin that plays a sound on compile is done
+
+# Usage
+
+```js 
+var SoundNotificationWebpackPlugin = require('sound-notification-webpack-plugin');
+
+new SoundNotificationWebpackPlugin(options);
+```
+
+## Default options:
+
+```js
+options = {
+  player: 'paplay',
+  successSound: '/usr/share/sounds/ubuntu/stereo/dialog-information.ogg',
+  errorSound: '/usr/share/sounds/ubuntu/stereo/dialog-error.ogg'
+}
+```