Skip to content

Commit

Permalink
Merge pull request #173 from aws/jagadeeshaby-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
jagadeeshaby authored Nov 25, 2019
2 parents f8ca87e + 439e868 commit 3f73256
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,18 @@ Connect Streams API which you will want to include in your page. You can serve
Install latest LTS version of [NodeJS](https://nodejs.org)

```
$ npm install -g gulp
$ git clone https://github.com/aws/amazon-connect-streams
$ cd amazon-connect-streams
$ npm install
$ gulp
$ npm run release
```

Find build artifacts in **release** directory - This will generate a file called `connect-streams.js` and the minified version of the same `connect-streams-min.js` - this is the full Connect Streams API which you will want to include in your page.

To run unit tests specifically:
```
$ gulp test
$ npm run test
```
## Initialization
Initializing the Streams API is the first step to verify that you have
Expand All @@ -90,6 +91,7 @@ everything setup correctly and that you will be able to listen for events.
connect.core.initCCP(containerDiv, {
ccpUrl: ccpUrl, /*REQUIRED*/
loginPopup: true, /*optional, default TRUE*/
region: region /*REQUIRED*/
softphone: { /*optional*/
disableRingtone: true, /*optional*/
ringtoneUrl: ringtoneUrl /*optional*/
Expand All @@ -103,6 +105,8 @@ and made available to your JS client code.
* `ccpUrl`: The URL of the CCP. This is the page you would normally navigate to
in order to use the CCP in a standalone page, it is different for each
instance.

* `region`: Amazon connect instance region. ex: us-west-2 for PDX ccp instance. only required for chat channel.
* `loginPopup`: Optional, defaults to `true`. Set to `false` to disable the login
popup which is shown when the user's authentication expires.
* `softphone`: This object is optional and allows you to specify some settings
Expand Down

0 comments on commit 3f73256

Please sign in to comment.