diff --git a/README.md b/README.md index eb3b4b9..2409453 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ This template is free for you to use or modify as you see fit. ## Getting started -The easiest way to get this app running is with the [Sandbox for LiveKit Cloud](https://cloud.livekit.io/projects/p_/sandbox) and the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup/). +The easiest way to get this app running is with a [token server](https://docs.livekit.io/frontends/authentication/tokens/sandbox-token-server/) and the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup/). -First, create a new [Sandbox Token Server](https://cloud.livekit.io/projects/p_mytc7vpzfkt/sandbox/templates/token-server) for your LiveKit Cloud project. +First, enable the token server from your project's **Options** on the [Settings](https://cloud.livekit.io/projects/p_/settings/project) page in LiveKit Cloud and copy the `sandboxID`. Then, run the following command to automatically clone this template and connect it to LiveKit Cloud: @@ -33,11 +33,11 @@ npx expo run:ios You'll also need an agent to speak with. Try our starter agent for [Python](https://github.com/livekit-examples/agent-starter-python), [Node.js](https://github.com/livekit-examples/agent-starter-node), or [create your own from scratch](https://docs.livekit.io/agents/start/voice-ai/). > [!NOTE] -> To setup without the LiveKit CLI, clone the repository and edit the `hooks/useConnectionDetails.ts` file to add either a `sandboxID` (if using a [Sandbox Token Server](https://cloud.livekit.io/projects/p_/sandbox/templates/token-server)), or a [manually generated](#token-generation) URL and token. +> To setup without the LiveKit CLI, clone the repository and edit the `hooks/useConnectionDetails.ts` file to add either a `sandboxID` (from your project's **Options** on the [Settings](https://cloud.livekit.io/projects/p_/settings/project) page), or a [manually generated](#token-generation) URL and token. ## Token generation -In a production environment, you will be responsible for developing a solution to [generate tokens for your users](https://docs.livekit.io/home/server/generating-tokens/) which is integrated with your authentication solution. You should disable your sandbox token server and modify `hooks/useConnectionDetails.ts` to use your own token server. +In a production environment, you will be responsible for developing a solution to [generate tokens for your users](https://docs.livekit.io/home/server/generating-tokens/) which is integrated with your authentication solution. You should disable the token server and modify `hooks/useConnectionDetails.ts` to use your own token server. ## Contributing diff --git a/hooks/useConnection.tsx b/hooks/useConnection.tsx index d6e5b90..214daaf 100644 --- a/hooks/useConnection.tsx +++ b/hooks/useConnection.tsx @@ -8,7 +8,7 @@ const sandboxID = ''; // The name of the agent you wish to be dispatched. const agentName = undefined -// NOTE: If you prefer not to use LiveKit Sandboxes for testing, you can generate your +// NOTE: If you prefer not to use the token server for testing, you can generate your // tokens manually by visiting https://cloud.livekit.io/projects/p_/settings/keys // and using one of your API Keys to generate a token with custom TTL and permissions.