aboutsummaryrefslogtreecommitdiff
path: root/node_modules/beeper/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/beeper/readme.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
add node_modules to address #4364
Diffstat (limited to 'node_modules/beeper/readme.md')
-rw-r--r--node_modules/beeper/readme.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/beeper/readme.md b/node_modules/beeper/readme.md
new file mode 100644
index 000000000..55bdd5298
--- /dev/null
+++ b/node_modules/beeper/readme.md
@@ -0,0 +1,55 @@
+# beeper [![Build Status](https://travis-ci.org/sindresorhus/beeper.svg?branch=master)](https://travis-ci.org/sindresorhus/beeper)
+
+> Make your terminal beep
+
+![](https://cloud.githubusercontent.com/assets/170270/5261236/f8471100-7a49-11e4-81af-96cd09a522d9.gif)
+
+Useful as an attention grabber e.g. when an error happens.
+
+
+## Install
+
+```
+$ npm install --save beeper
+```
+
+
+## Usage
+
+```js
+var beeper = require('beeper');
+
+beeper();
+// beep one time
+
+beeper(3);
+// beep three times
+
+beeper('****-*-*');
+// beep, beep, beep, beep, pause, beep, pause, beep
+```
+
+
+## API
+
+It will not beep if stdout is not TTY or if the user supplies the `--no-beep` flag.
+
+### beeper([count|melody], [callback])
+
+#### count
+
+Type: `number`
+Default: `1`
+
+How many times you want it to beep.
+
+#### melody
+
+Type: `string`
+
+Construct your own melody by supplying a string of `*` for beep `-` for pause.
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)