Commit 88f43094 authored by Chris Lord's avatar Chris Lord
Browse files

Add a README.md

parent 04f9aefa
# Wakeword
Wakeword is a utility library to facilitate responding to particular set words or phrases spoken into a microphone. This is achieved using the Pocketsphinx library, an open source speech recognition library suitable for use on embedded devices.
## Example
```
const Wakeword = require('wakeword');
// Disable log output
Wakeword.logFile = '/dev/null';
function listen() {
Wakeword.listen(['hello', 'goodbye'], 0.87, (data, word) => {
console.log(word);
if (word !== 'goodbye') {
Wakeword.resume();
} else {
Wakeword.stop();
}
});
}
listen();
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment