Skip to content

Commit 31e032c

Browse files
committed
typos, organization
1 parent 2a3c734 commit 31e032c

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Allows you to easily add voice recognition and synthesis to any web app with min
88

99
**Warning** This library is still has a few rough edges and may yet see breaking changes.
1010

11+
1112
### For Web Browsers Only
1213
This library is primarily intended for use in browsers.
1314
Check out [watson-developer-cloud](https://www.npmjs.com/package/watson-developer-cloud) to use Watson services (speech and others) from Node.js.
@@ -18,26 +19,28 @@ The examples/ folder includes example Node.js and Python servers, and SDKs are a
1819
[Python](https://github.com/watson-developer-cloud/python-sdk/blob/master/examples/authorization_v1.py),
1920
and there is also a [REST API](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-tokens.shtml).
2021

21-
### Examples
22-
See several examples at https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples
2322

24-
### Installation - npm
23+
### Installation - standalone
24+
25+
Pre-compiled bundles are available from on GitHub Releases - just download the file and drop it into your project: https://github.com/watson-developer-cloud/speech-javascript-sdk/releases
26+
27+
28+
### Installation - npm with browserify
2529

2630
This library is built with [browserify](http://browserify.org/) and easy to use in browserify-based projects :
2731

2832
npm install --save watson-speech
2933

30-
### Installation - standalone
3134

32-
Pre-compiled bundles are also available from on GitHub Releases: https://github.com/watson-developer-cloud/speech-javascript-sdk/releases
35+
API & Examples
36+
--------------
3337

34-
API
35-
---
38+
The basic API is outlined below, see complete API docs at http://watson-developer-cloud.github.io/speech-javascript-sdk/master/
3639

37-
The basic API is outlined here, see complete API docs at http://watson-developer-cloud.github.io/speech-javascript-sdk/master/
40+
See several examples at https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples/static/
3841

3942
All API methods require an auth token that must be [generated server-side](https://github.com/watson-developer-cloud/node-sdk#authorization).
40-
(Snp teee examples/token-server.js for a basic example.)
43+
(See https://github.com/watson-developer-cloud/speech-javascript-sdk/tree/master/examples/ for a couple of basic examples in Node.js and Python.)
4144

4245
## [`WatsonSpeech.TextToSpeech`](http://watson-developer-cloud.github.io/speech-javascript-sdk/master/module-watson-speech_text-to-speech.html)
4346

@@ -56,7 +59,7 @@ Options:
5659
## [`WatsonSpeech.SpeechToText`](http://watson-developer-cloud.github.io/speech-javascript-sdk/master/module-watson-speech_speech-to-text.html)
5760

5861

59-
### [`.recognizeMicrophone({token})`](http://watson-developer-cloud.github.io/speech-javascript-sdk/master/module-watson-speech_speech-to-text_recognize_microphone.html) -> [`RecognizeStream`][RecognizeStream]
62+
### [`.recognizeMicrophone({token})`](http://watson-developer-cloud.github.io/speech-javascript-sdk/master/module-watson-speech_speech-to-text_recognize-microphone.html) -> [`RecognizeStream`][RecognizeStream]
6063

6164
Options:
6265
* `keepMic`: if true, preserves the MicrophoneStream for subsequent calls, preventing additional permissions requests in Firefox
@@ -71,7 +74,7 @@ Pipes results through a [FormatStream] by default, set `options.format=false` to
7174
Known issue: Firefox continues to display a microphone icon in the address bar after recording has ceased. This is a browser bug.
7275

7376

74-
### [`.recognizeFile({data, token})`](http://watson-developer-cloud.github.io/speech-javascript-sdk/master/module-watson-speech_speech-to-text_recognize_file.html) -> [`RecognizeStream`][RecognizeStream]
77+
### [`.recognizeFile({data, token})`](http://watson-developer-cloud.github.io/speech-javascript-sdk/master/module-watson-speech_speech-to-text_recognize-file.html) -> [`RecognizeStream`][RecognizeStream]
7578

7679
Can recognize and optionally attempt to play a [File](https://developer.mozilla.org/en-US/docs/Web/API/File) or [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob)
7780
(such as from an `<input type="file"/>` or from an ajax request.)

0 commit comments

Comments
 (0)