diff --git a/README.md b/README.md index dc6f1b4..ad9373f 100644 --- a/README.md +++ b/README.md @@ -8,24 +8,20 @@ This demo app uses browser microphone input and client-side JavaScript to demons Check out the [Amazon Transcribe WebSocket docs](https://docs.aws.amazon.com/transcribe/latest/dg/websocket.html). +**Note**: This sample uses the [AWS SDK v3](https://github.com/aws/aws-sdk-js-v3) that is currently in preview. If you plan to use the AWS SDK v3 in your +project, please be aware of the possible breaking change. If you have feedbacks to JS SDK client, please [open an issue on the SDK repository](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + ## Building and Deploying [![amplifybutton](https://oneclick.amplifyapp.com/button.svg)](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/aws-samples/amazon-transcribe-websocket-static) Even though this is a static site consisting only of HTML, CSS, and client-side JavaScript, there is a build step required. Some of the modules used were originally made for server-side code and do not work natively in the browser. -We use [browserify](https://github.com/browserify/browserify) to enable browser support for the JavaScript modules we `require()`. - 1. Clone the repo -2. run `npm install` -3. run `npm run-script build` to generate `dist/main.js`. -Once you've bundled the JavaScript, all you need is a webserver. For example, from your project directory: +1. run `yarn` -``` -npm install --global local-web-server -ws -``` +1. run `yarn start`. This command will automatically load the sample app in your browser. ### Credits @@ -33,4 +29,4 @@ This project is based on code written by Karan Grover from the Amazon Transcribe ## License -This library is licensed under the Apache 2.0 License. \ No newline at end of file +This library is licensed under the Apache 2.0 License. diff --git a/index.html b/index.html index 262c389..a36aef4 100644 --- a/index.html +++ b/index.html @@ -98,7 +98,7 @@