1.3.0 (#20)

* 1.3.0 update

purejs-demo/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/coffeelint",
   "name": "videosdk-demo-purejs",
-  "version": "1.2.7",
+  "version": "1.3.0",
   "description": "Zoom Web Video SDK Pure JS Demo",
   "main": "index.js",
   "scripts": {
@@ -51,6 +51,6 @@
     "webpack-dev-server": "3.11.2"
   },
   "dependencies": {
-    "@zoom/videosdk": "^1.2.7"
+    "@zoom/videosdk": "^1.3.0"
   }
 }

react-demo/package.json

@@ -1,13 +1,13 @@
 {
   "name": "react-video-sdk-demo",
-  "version": "1.2.7",
+  "version": "1.3.0",
   "private": true,
   "dependencies": {
     "@ant-design/icons": "^4.6.2",
     "@testing-library/jest-dom": "^5.11.9",
     "@testing-library/react": "^11.2.5",
     "@testing-library/user-event": "^12.8.3",
-    "@zoom/videosdk": "^1.2.7",
+    "@zoom/videosdk": "^1.3.0",
     "antd": "^4.14.1",
     "classnames": "^2.2.6",
     "crypto-js": "^4.0.0",

readme.md

@@ -1,63 +1,66 @@
-# Zoom Video Web SDK
-Use of this sample app is subject to our [Terms of Use](https://zoom.us/docs/en-us/zoom_api_license_and_tou.html)
+# Zoom Video SDK Sample App - Web
 
-Please note that Chrome 92 is released on July 20, 2021, and that starting with its release, the SharedArrayBuffer object will only work on websites with proper cross-origin isolation. The Video SDK uses SharedArrayBuffer to optimize media streaming performance, and the SDK will not work properly if you do use it in an environment that is not properly cross-origin isolated.
+Use of this sample app is subject to our [Terms of Use](https://zoom.us/docs/en-us/zoom_api_license_and_tou.html).
 
-As an alternative, you may temporarily apply for the `SharedArrayBuffers` [origintrials](https://developer.chrome.com/origintrials/#/trials/active) for your domain; this will exempt your domain from the cross-origin isolation requirements, and allow you and your users to use SharedArrayBuffer on your domain until the Chrome 94 release.
+The [Zoom Video SDK](https://marketplace.zoom.us/docs/sdk/video/web) enables you to build custom video experiences with Zoom's core technology through a highly optimized WebAssembly module.
 
-## What is Zoom Video Web SDK?
-Zoom Video Web SDK is the app development kit provided to enable apps designed to connect people and to share happiness. With Video Web SDK, you can build feature-rich apps with highly customized user-interfaces
+## Installation
 
-### Video Web SDK is designed to be:
-* <strong>Easy to use</strong>: Video SDKs have simplified most function calls, allowing you to have a high-quality video session with simple calls and options.
-* <strong>Lightweight</strong>: Video SDKs are lighterthan ever, with an enormous reduction in size compared to Client
-SDKs with the same quality of the Zoomʼs video and audio solutions.
+To get started, clone the repo:
 
-### The Video Web SDK provides the ability to experience the following functionality for your app:
-* Launch a video communication session instantly
-* Share screen directly from your device
-* Send instant chat messages during the session
+`$ git clone https://github.com/zoom/sample-app-videosdk.git`
 
-# Install 
-## Prerequisites
-* A browser [Please see the browser support info here](https://marketplace.zoom.us/docs/sdk/video/web)
-* A Zoom account with Video SDK Account Type
-* Zoom Video SDK developer credentials
+## Setup
 
-## Installation
-```
-npm install @zoom/videosdk
-```
+1. Once cloned, navigate to the `sample-app-videosdk/react-demo` directory for the React sample or `sample-app-videosdk/purejs-demo` for the Vanilla JavaScript sample:
+
+   `$ cd sample-app-videosdk/react-demo` or `$ cd sample-app-videosdk/purejs-demo`
+
+   <i>Primary differences are that the former is built in React and is a much more comprehensive overview of the Video SDK, while the latter showcases a very simple use-case for those uncomfortable with React</i>
+
+1. Then install the dependencies:
+
+   `$ npm install`
+
+1. Open the directory in your code editor.
+
+1. Open the `react-demo/src/config/dev.ts` or `purejs-demo/src/js/config.js` file respectively, and enter required session values for the variables:
+
+   | Key                   | Value Description |
+   | -----------------------|-------------|
+   | `sdkKey`     | Your Video SDK Key. Required. |
+   | `sdkSecret`  | Your Video SDK Secret. Required. |
+   | `topic`      | Required, a session name of your choice or the name of the session you are joining. |
+   | `name`       | Required, a name for the participant. |
+   | `password`   | Required, a session passcode of your choice or the passcode of the session you are joining. |
 
-## React Demo
-```
-git clone https://github.com/zoom/sample-app-videosdk.git --branch master --depth 1
-cd sample-app-videosdk/react-demo
-npm install
-npm run start
+   Example:
 
-```
+   ```js
+   {
+     sdkKey: 'YOUR_VIDEO_SDK_KEY',
+     sdkSecret: 'YOUR_VIDEO_SDK_SECRET',
+     topic: 'Cool Cars',
+     name: 'user123',
+     password: 'abc123'
+   }
+   ```
 
-Before you can use the demo app, you must update your config in ```react-demo/src/config/dev.ts```
+   > Reminder to not publish this sample app as is. Replace the frontend signature generator with a [backend signature generator](https://marketplace.zoom.us/docs/sdk/video/auth#generate-the-video-sdk-jwt) to keep your SDK Secret safe.
 
-## Purejs Demo
-```
-git clone https://github.com/zoom/sample-app-videosdk.git --branch master --depth 1
-cd sample-app-videosdk/purejs-demo
-npm install
-npm run start
+1. Save `config.js` or `dev.ts` respectively.
 
-```
+1. Run the app:
 
-```npm run https``` and ```npm run corp``` can also be used as alternatives to ```npm run start```; ```corp``` provides proper cross-origin isolation that optimizes performance through enabling the use of SharedArrayBuffers
+   `$ npm start`
 
-Before you can use the demo app, you must update your config in ```purejs-demo/src/js/config.js```
+## Usage
 
-You can launch the app at http://localhost:3000 or https://localhost:3000 (if using ```npm run https```)
+1. Navigate to http://localhost:3000. For the `purejs-demo` click "Join" or for the `react-demo` click one of the feature boxes.
 
-## Changelog
-Please refer to the official release CHANGELOG for all changes
+> Learn more about [rendering multiple video streams](https://marketplace.zoom.us/docs/sdk/overview/websdk-gallery-view).
 
+For the full list of features and event listeners, as well as additional guides, see our [Video SDK docs](https://marketplace.zoom.us/docs/sdk/video/web).
 
 ## Need help?