Skip to content

Commit 4d59bb1

Browse files
author
Tim Mendoza
committed
Update documentation
1 parent 31c5d96 commit 4d59bb1

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ OPTIONS
229229
--authentication=(passcode) (required) Type of authentication to use
230230
--override Override an existing App deployment
231231
--room-type=(group|group-small|peer-to-peer|go) [default: group] Set room type
232+
--[no-]ui-editable Specifies whether the app's files and variables can be edited in the Twilio console.
232233
233234
DESCRIPTION
234235
This command publishes two components as a Twilio Function: an application token
@@ -251,6 +252,7 @@ EXAMPLES
251252
Passcode: xxx xxx xxxx xxxx
252253
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
253254
Room Type: group
255+
Edit your token server at: https://www.twilio.com/console/functions/editor/...
254256
255257
# Deploy an application token server with the React app
256258
$ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
@@ -259,6 +261,7 @@ EXAMPLES
259261
Passcode: xxx xxx xxxx xxxx
260262
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
261263
Room Type: group
264+
Edit your token server at: https://www.twilio.com/console/functions/editor/...
262265
263266
# Override an existing app with a fresh deployment
264267
# Please note that this will remove a previously deployed web application if no
@@ -269,13 +272,15 @@ EXAMPLES
269272
Passcode: yyy yyy yyyy yyyy
270273
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
271274
Room Type: group
275+
Edit your token server at: https://www.twilio.com/console/functions/editor/...
272276
273277
# Deploy an application token server with a specific room type
274278
$ twilio rtc:apps:video:deploy --authentication passcode --room-type peer-to-peer
275279
deploying app... done
276280
Passcode: xxx xxx xxxx xxxx
277281
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
278282
Room Type: peer-to-peer
283+
Edit your token server at: https://www.twilio.com/console/functions/editor/...
279284
```
280285

281286
## `twilio rtc:apps:video:view`
@@ -295,6 +300,7 @@ EXAMPLE
295300
Web App URL: https://video-app-1111-dev.twil.io?passcode=xxxxxxxxxxxxxx
296301
Passcode: xxx xxx xxxx xxxx
297302
Room Type: group
303+
Edit your token server at: https://www.twilio.com/console/functions/editor/...
298304
```
299305

300306
<!-- commandsstop -->

src/commands/rtc/apps/video/deploy.js

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,17 @@ $ twilio rtc:apps:video:deploy --authentication passcode
8282
deploying app... done
8383
Passcode: xxx xxx xxxx xxxx
8484
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
85-
Room Type: group`,
85+
Room Type: group
86+
Edit your token server at: https://www.twilio.com/console/functions/editor/...`,
8687
`
8788
# Deploy an application token server with the React app
8889
$ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
8990
deploying app... done
9091
Web App URL: https://video-app-xxxx-xxxx-dev.twil.io?passcode=xxxxxxxxxxxxxx
9192
Passcode: xxx xxx xxxx xxxx
9293
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
93-
Room Type: group`,
94+
Room Type: group
95+
Edit your token server at: https://www.twilio.com/console/functions/editor/...`,
9496
`
9597
# Override an existing app with a fresh deployment
9698
# Please note that this will remove a previously deployed web application if no
@@ -100,14 +102,16 @@ Removed app with Passcode: xxx xxx xxxx xxxx
100102
deploying app... done
101103
Passcode: yyy yyy yyyy yyyy
102104
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
103-
Room Type: group`,
105+
Room Type: group
106+
Edit your token server at: https://www.twilio.com/console/functions/editor/...`,
104107
`
105108
# Deploy an application token server with a specific room type
106109
$ twilio rtc:apps:video:deploy --authentication passcode --room-type peer-to-peer
107110
deploying app... done
108111
Passcode: xxx xxx xxxx xxxx
109112
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
110-
Room Type: peer-to-peer`,
113+
Room Type: peer-to-peer
114+
Edit your token server at: https://www.twilio.com/console/functions/editor/...`,
111115
];
112116

113117
module.exports = DeployCommand;

src/commands/rtc/apps/video/view.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ ViewCommand.description = 'View a Programmable Video app';
1515
ViewCommand.examples = [
1616
`$ twilio rtc:apps:video:view
1717
Web App URL: https://video-app-1111-dev.twil.io?passcode=1111111111
18-
Passcode: 1111111111`,
18+
Passcode: 1111111111
19+
Edit your token server at: https://www.twilio.com/console/functions/editor/...`,
1920
];
2021

2122
module.exports = ViewCommand;

0 commit comments

Comments
 (0)