Skip to content

Commit bb48e63

Browse files
committed
adding readme to examples with setup info and prerequesites
1 parent 0485be3 commit bb48e63

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

examples/readme.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Watson Speech JavaScript SDK Examples
2+
=====================================
3+
4+
This folder has a basic node.js server to host files and generate auth tokens and
5+
several html files with different examples of using the Speech SDJ.
6+
7+
There are also a few audio files to test with in the public/ folder.
8+
9+
10+
Prerequisite
11+
------------
12+
13+
* IBM Watson Speech to Text service credentials - see http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-credentials.shtml
14+
* [Node.js](https://nodejs.org/en/) (see notes)
15+
16+
17+
Setup
18+
-----
19+
20+
1. `cd` into the `examples/` directory and run `npm install` to grab dependencies
21+
2. edit `token-server.js` to include your service credentials
22+
3. run `npm start`
23+
4. Open your browser to http://localhost:3000/ to see the examples.
24+
25+
26+
Notes
27+
-----
28+
29+
* The examples all use jQuery, but it is not required to use the Speech SDK.
30+
* The examples use a node.js server to generate tokens. Node.js is not requred, but *some server-side token generator is required*.
31+
The SDK will not accept your service credentials directly, and you can not use them to generate a token client-side.
32+
SDKs are available for [Node.js](https://github.com/watson-developer-cloud/node-sdk#authorization),
33+
[Java](https://github.com/watson-developer-cloud/java-sdk),
34+
[Python](https://github.com/watson-developer-cloud/python-sdk/blob/master/examples/authorization_v1.py),
35+
and there is a [REST API](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-tokens.shtml)
36+
for use with other languages (or `curl`).
37+
* The Speech SDK may be used in browserify or as a standalone library; all of the current examples use it as a standalone library for simplicity.

0 commit comments

Comments
 (0)