twilio-sync - npm Package Compare versions

Comparing version 3.0.4-rc.6 to 3.0.4-rc.7

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+### [3.0.4-rc.7](https://github.com/twilio/rtd-sdk-monorepo-js/compare/twilio-sync@3.0.4-rc.6...twilio-sync@3.0.4-rc.7) (2021-08-03)
+
+**Note:** Version bump only for package twilio-sync
+
+
+
+
+
 ### [3.0.4-rc.6](https://github.com/twilio/rtd-sdk-monorepo-js/compare/twilio-sync@3.0.4-rc.5...twilio-sync@3.0.4-rc.6) (2021-07-30)
@@ -8,0 +16,0 @@

package.json

 {
   "name": "twilio-sync",
-  "version": "3.0.4-rc.6",
+  "version": "3.0.4-rc.7",
   "description": "Twilio Sync client library",
@@ -42,3 +42,3 @@ "main": "./dist/lib.js",
     "platform": "^1.3.6",
-    "twilsock": "^0.11.5-rc.6",
+    "twilsock": "^0.11.5-rc.7",
     "uuid": "^3.3.2"
@@ -45,0 +45,0 @@ },

README.md

@@ -1,3 +0,2 @@
-Twilio Sync JavaScript client library
-===============
+# Twilio Sync JavaScript client library
 
@@ -7,10 +6,12 @@ Twilio Sync is Twilio's state synchronization service, offering two-way real-time communication between browsers, mobiles, and the cloud.
 
-Installation
-------------
+## Installation
 
-### NPM
+### via NPM
+
 ```
 npm install --save twilio-sync
 ```
+
 Using this method, you can `require` twilio-sync.js like so:
+
 ```
@@ -21,9 +22,13 @@ var SyncClient = require('twilio-sync');
 
-### CDN
+### via CDN
+
 Releases of twilio-sync.js are hosted on a CDN, and you can include these
 directly in your web app using a <script> tag.
+
 ```
-<script type="text/javascript" src="//media.twiliocdn.com/sdk/js/sync/v1.0/twilio-sync.min.js"></script>
+<script type="text/javascript" src="//media.twiliocdn.com/sdk/js/sync/v3.0/twilio-sync.min.js"></script>
 ```
+
 Using this method, twilio-sync.js will set a browser global:
+
 ```
@@ -33,8 +38,7 @@ var syncClient = new Twilio.Sync.Client(token);
 
+## Usage
 
-Usage
------
 To use the library, you need to generate an [Access Token](https://www.twilio.com/docs/sync/identity-and-access-tokens) and pass it to the Sync Client constructor.
 The Twilio SDK Starter applications for [Node.js](https://github.com/TwilioDevEd/sdk-starter-node), [Java](https://github.com/TwilioDevEd/sdk-starter-java), [PHP](https://github.com/TwilioDevEd/sdk-starter-php), [Ruby](https://github.com/TwilioDevEd/sdk-starter-ruby), [Python](https://github.com/TwilioDevEd/sdk-starter-python), [C#](https://github.com/TwilioDevEd/sdk-starter-csharp) provide an easy way to set up a token generator locally.
-Alternatively, you can set up a [Twilio Function based on the _Sync Access Token_ template](https://www.twilio.com/console/runtime/functions/manage).    
+Alternatively, you can set up a [Twilio Function based on the _Sync Access Token_ template](https://www.twilio.com/console/runtime/functions/manage).
 
@@ -66,12 +70,6 @@ ```
 
-For more code examples for Documents and other Sync objects, refer to the [SDK API Docs](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs):
-* [Documents](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs/Document.html)
-* [Lists](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs/List.html)
-* [Maps](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs/Map.html)
-* [Message Streams](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs/Stream.html)
-* [Live Query](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs/LiveQuery.html)
-* [Instant Query](https://media.twiliocdn.com/sdk/js/sync/v0.12/docs/InstantQuery.html)
+For more code examples for Documents and other Sync objects, refer to the [SDK API Docs](https://media.twiliocdn.com/sdk/js/sync/latest/docs).
 
-Changelog
----------
-See this [link](https://www.twilio.com/docs/sync/javascript-sdk-changelog#version-history-changelog).
+## Changelog
+
+See this [link](https://www.twilio.com/docs/sync/javascript/changelog).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

44828

increased by0.02%

Worsened metrics

Total package byte prevSize

10689025

decreased by-0.01%

Number of lines in readme file

72

decreased by-2.7%

Dependency changes

• Updatedtwilsock@^0.11.5-rc.7