Skip to content

Commit b7d411b

Browse files
update README
1 parent 927ddf7 commit b7d411b

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,23 +77,34 @@ This starter is designed to be flexible so you can adapt it to your specific age
7777
#### Example: App configuration (`app-config.ts`)
7878

7979
```ts
80-
export const APP_CONFIG_DEFAULTS = {
80+
export const APP_CONFIG_DEFAULTS: AppConfig = {
8181
companyName: 'LiveKit',
8282
pageTitle: 'LiveKit Voice Agent',
8383
pageDescription: 'A voice agent built with LiveKit',
84+
8485
supportsChatInput: true,
8586
supportsVideoInput: true,
8687
supportsScreenShare: true,
88+
isPreConnectBufferEnabled: true,
89+
8790
logo: '/lk-logo.svg',
8891
accent: '#002cf2',
8992
logoDark: '/lk-logo-dark.svg',
9093
accentDark: '#1fd5f9',
9194
startButtonText: 'Start call',
95+
96+
// for LiveKit Cloud Sandbox
97+
sandboxId: undefined,
98+
agentName: undefined,
9299
};
93100
```
94101

95102
You can update these values in [`app-config.ts`](./app-config.ts) to customize branding, features, and UI text for your deployment.
96103

104+
> [!NOTE]
105+
> The `sandboxId` and `agentName` are for the LiveKit Cloud Sandbox environment.
106+
> They are not used for local development.
107+
97108
#### Environment Variables
98109

99110
You'll also need to configure your LiveKit credentials in `.env.local` (copy `.env.example` if you don't have one):

app-config.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ export const APP_CONFIG_DEFAULTS: AppConfig = {
3636
startButtonText: 'Start call',
3737

3838
// for LiveKit Cloud Sandbox
39-
// these must be defined to satisfy `getAppConfig` in `lib/utils.ts`
40-
sandboxId: undefined as string | undefined,
41-
agentName: undefined as string | undefined,
39+
sandboxId: undefined,
40+
agentName: undefined,
4241
};

0 commit comments

Comments
 (0)