speech-to-text - npm Package Compare versions

Comparing version 0.3.4 to 0.3.5

package.json

 {
   "name": "speech-to-text",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "A speech to text module.",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -7,6 +7,34 @@ # speech-recognition
 
-$ npm install --save speech-to-text
+`npm install --save speech-to-text`
 
+## Usage
+
+````
+import SpeechToText from 'speech-to-text';
+
+const onAnythingSaid = text => console.log(`Interim text: ${text}`);
+const onFinalised = text => console.log(`Finalised text: ${text}`);
+
+try {
+  const listener = new SpeechToText(onAnythingSaid, onFinalised);
+  listener.startListening();
+} catch (error) {
+  console.log(error);
+}
+````
+
+## API
+
+### The constructor
+
+- onAnythingSaid: this is a callback function that is called with text as it's being said
+- onFinalised: this is a callback function that is called with the full text as it has been resolved in the cloud.
+- language: This is an optional string that specifies the language to be interpreted as. Default is United States English. 'en-US'
+
+### startListening
+
+Initiates listening to speech input and will continue to call the callback functions provided until the speech is finalised. After which you'll need to call this function again.
+
 ## License
 
-speech-to-text is released under the MIT license.
+MIT

No alert changes

Improved metrics

Total package byte prevSize

6266

increased by16.02%

Number of lines in readme file

40

increased by233.33%

No dependency changes