@twilio/conversations 2.0.0-rc.1 → 2.0.1-canary.1

package/README.md

@@ -7,33 +7,38 @@ Visit our official site for more detalis: [https://www.twilio.com/conversations]
 
 Instantiating and using
 ------------
-To use the library you need [to generate a token](https://www.twilio.com/docs/conversations/create-tokens) and pass it to the conversations Client `create` factory.
+To use the library you need [to generate a token](https://www.twilio.com/docs/conversations/create-tokens) and pass it to the Conversations Client constructor.
 
 ### NPM
 ```
 npm install --save @twilio/conversations
 ```
 
-Using this method, you can `require` `twilio-conversations` and then use the client:
+Using this method, you can `require` `twilio-conversations` and then use the 
+client:
 ```
-const Conversations = require('@twilio/conversations');
-Conversations.Client.create(token).then(client => {
-    // Use client
-});
-```
-
-Or, if you prefer `async`/`await` syntax:
-```
-const Conversations = require('@twilio/conversations');
-const client = await Conversations.Client.create(token);
-// Use client
+const { Client } = require('@twilio/conversations');
+const client = new Client(token);
+// Before you use the client, subscribe to the `'stateChanged'` event and wait 
+// for the `'initialized'` state to be reported.
+client.on('stateChanged', (state) => {
+  if (state === 'initialized') {
+    // Use the client
+  }
+}
 ```
 
 The SDK could also be imported using the ES module syntax:
 ```
-import Conversations from '@twilio/conversations';
-const client = await Conversations.Client.create(token);
-// Use client
+import { Client } from '@twilio/conversations';
+const client = new Client(token);
+// Before you use the client, subscribe to the `'stateChanged'` event and wait 
+// for the `'initialized'` state to be reported.
+client.on('stateChanged', (state) => {
+  if (state === 'initialized') {
+    // Use the client
+  }
+}
 ```
 
 ### CDN
@@ -41,19 +46,11 @@ const client = await Conversations.Client.create(token);
 Releases of `twilio-conversations.js` are hosted on a CDN, and you can include these
 directly in your web app using a `<script>` tag.
 ```html
-<script src="https://media.twiliocdn.com/sdk/js/conversations/v1.2/twilio-conversations.min.js"></script>
+<script src="https://media.twiliocdn.com/sdk/js/conversations/v2.0/twilio-conversations.min.js"></script>
 ```
-Using this method, `twilio-conversations.js` will set a browser global `Twilio.Conversations` through which you can use the client :
-```
-Twilio.Conversations.Client.create(token).then(client => {
-    // Use client
-});
-```
-
-or, if you prefer `async`/`await` syntax:
+Using this method, `twilio-conversations.js` will set a browser global `Twilio.Conversations` through which you can use the client:
 ```
-let client = await Twilio.Conversations.Client.create(token);
-// Use client
+const client = new Twilio.Conversations.Client(token);
 ```
 
 ### Security
@@ -67,7 +64,7 @@ number. While less flexible it is significantly more secure, which is required b
 To consume securely use the following script snippet format:
 
 ```html
-<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/1.2.0/twilio-conversations.min.js"
+<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.1/twilio-conversations.min.js"
         integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
         crossorigin="anonymous"></script>
 ```