@twilio/conversations 3.0.0-rc.9 → 3.0.1-rc.1

package/README.md

@@ -1,58 +1,66 @@
+# Twilio Conversations client library
 
-Twilio Conversations client library
-=============
 Twilio Conversations: Create meaningful connections with customers across various communication channels.
 Visit our official site for more detalis: [https://www.twilio.com/conversations](https://www.twilio.com/conversations)
 
+## Instantiating and using
 
-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 constructor.
 
 ### NPM
+
 ```
 npm install --save @twilio/conversations
 ```
 
-Using this method, you can `require` `twilio-conversations` and then use the 
+Using this method, you can `require` `twilio-conversations` and then use the
 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, error }) => {
-  if (state === 'initialized') {
-    // Use the client
-  }
-  
-  if (error) {
-    // Handle error
-  }
-}
+
+// Before you use the client, subscribe to the `'initialized'` event.
+client.on('initialized', () => {
+  // Use the client.
+});
+
+// To catch client initialization errors, subscribe to the `'initFailed'` event.
+client.on('initFailed', ({ error }) => {
+  // Handle the error.
+});
 ```
 
 The SDK could also be imported using the ES module syntax:
+
 ```
 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, error }) => {
-  if (state === 'initialized') {
-    // Use the client
-  }
-}
+
+// Before you use the client, subscribe to the `'initialized'` event.
+client.on('initialized', () => {
+  // Use the client.
+});
+
+// To catch client initialization errors, subscribe to the `'initFailed'` event.
+client.on('initFailed', ({ error }) => {
+  // Handle the error.
+});
 ```
 
 ### CDN
 
 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/v3.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:
+
 ```
 const client = new Twilio.Conversations.Client(token);
 ```
@@ -68,13 +76,15 @@ 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/3.0.0/twilio-conversations.min.js"
-        integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
-        crossorigin="anonymous"></script>
+<script
+  src="https://media.twiliocdn.com/sdk/js/conversations/releases/3.0.1/twilio-conversations.min.js"
+  integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
+  crossorigin="anonymous"
+></script>
 ```
 
-Find the hash of each release published on the [Changelog](#Changelog) page.
+Find the hash of each release published on the [Changelog](#changelog) page.
 
-###  Changelog
+### Changelog
 
 See this [link](https://www.twilio.com/docs/conversations/javascript/changelog).