Skip to content

Commit eb854c9

Browse files
committed
docs: update readme
1 parent ac9aeda commit eb854c9

File tree

5 files changed

+9
-10
lines changed

5 files changed

+9
-10
lines changed
-273 KB
Binary file not shown.
3.21 MB
Loading

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
<img src="./.github/assets/app-icon.png" alt="Voice Assistant App Icon" width="100" height="100">
22

3-
# Web Voice Assistant
3+
# Embed Starter
44

5-
This is a starter template for [LiveKit Agents](https://docs.livekit.io/agents) that provides a simple voice interface using the [LiveKit JavaScript SDK](https://github.com/livekit/client-sdk-js). It supports [voice](https://docs.livekit.io/agents/start/voice-ai), [transcriptions](https://docs.livekit.io/agents/build/text/), and [virtual avatars](https://docs.livekit.io/agents/integrations/avatar).
5+
This is a starter template for [LiveKit Agents](https://docs.livekit.io/agents) that provides an example of how you might approach building a LiveKit web embed using the [LiveKit JavaScript SDK](https://github.com/livekit/client-sdk-js). It supports [voice](https://docs.livekit.io/agents/start/voice-ai), [transcriptions](https://docs.livekit.io/agents/build/text/), and [virtual avatars](https://docs.livekit.io/agents/integrations/avatar).
66

77
This template is built with Next.js and is free for you to use or modify as you see fit.
8-
s
9-
![App screenshot](/.github/assets/frontend-screenshot.jpeg)
8+
9+
![App screenshot](/.github/assets/frontend-screenshot.png)
1010

1111
## Getting started
1212

1313
> [!TIP]
14-
> If you'd like to try this application without modification, you can deploy an instance in just a few clicks with [LiveKit Cloud Sandbox](https://cloud.livekit.io/projects/p_/sandbox/templates/voice-assistant-frontend).
14+
> If you'd like to try this application without modification, you can deploy an instance in just a few clicks with [LiveKit Cloud Sandbox](https://cloud.livekit.io/projects/p_/sandbox/templates/embed).
1515
1616
Run the following command to automatically clone this template.
1717

1818
```bash
19-
lk app create --template voice-assistant-frontend
19+
lk app create --template embed
2020
```
2121

2222
Then run the app with:
@@ -26,7 +26,7 @@ pnpm install
2626
pnpm dev
2727
```
2828

29-
And open http://localhost:3000 in your browser.
29+
Open http://localhost:3000 in your browser, and follow the instructions.
3030

3131
You'll also need an agent to speak with. Try our [Voice AI Quickstart](https://docs.livekit.io/start/voice-ai) for the easiest way to get started.
3232

app-config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import type { AppConfig } from './lib/types';
22

33
export const APP_CONFIG_DEFAULTS: AppConfig = {
44
companyName: 'LiveKit',
5-
pageTitle: 'LiveKit Voice Agent',
6-
pageDescription: 'A voice agent built with LiveKit',
5+
pageTitle: 'LiveKit Embed',
6+
pageDescription: 'A web embed connected to an agent, built with LiveKit',
77

88
supportsChatInput: true,
99
supportsVideoInput: true,

app/(app)/embed/page.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ export default async function Embed() {
66
const hdrs = await headers();
77
const origin = getOrigin(hdrs);
88

9-
// FIXME: what is this appConfig thing used for? Do I need it for the embed?
109
const appConfig = await getAppConfig(origin);
1110

1211
return <EmbedAgentClient appConfig={appConfig} />;

0 commit comments

Comments
 (0)