- Agent is listening, ask it a question -
-diff --git a/README.md b/README.md index 3b0854ac..1cf77ab9 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,568 @@ +
48 production-ready examples showcasing the power of LiveKit Agents
+ +[](https://docs.livekit.io/agents/) +[](https://www.python.org/) +[](#examples) -## What's Inside -- Voice, video, and telephony agents that demonstrate LiveKit's real-time APIs and the `livekit-agents` Python SDK -- Metadata-rich examples – every script now starts with YAML frontmatter (title, category, tags, difficulty, description, demonstrates) so tooling and LLMs can reason about the catalog -- A centralized index (`docs/index.yaml`) that lists every example along with its metadata for fast discovery and automation -- Complex demos that showcase advanced patterns such as multi-agent orchestration, RPC integrations, hardware bridges, benchmarking, and testing utilities ++ Getting Started • + Browse Examples • + Documentation • + Community +
-## Discover the Catalog -- Browse `docs/index.yaml` for the complete list of examples, their descriptions, tags, and demonstrated concepts -- Use the frontmatter at the top of each script (inside a triple-quoted string) to inspect metadata directly in the file -- Many larger demos include their own `README.md` with architectural details or frontend instructions +- {reason} - - See quickstart guide - - . -
- ), - }); - room.disconnect(); - } - }, 10_000); - - return () => clearTimeout(timeout); - } - }, [agentState, sessionStarted, room]); - - return ( -- Agent is listening, ask it a question -
-- Chat live with your voice AI agent -
- -- Need help getting set up? Check out the{' '} - - Voice AI quickstart - - . -
-- Your total is ${checkoutState.total_price.toFixed(2)} -
-- Please drive to the next window! -
-- {orderState.item_count} {orderState.item_count === 1 ? 'item' : 'items'} -
-Welcome to McDonald's
-Please place your order
-- {key}: {value} -
- ))} -- {reason} - - See quickstart guide - - . -
- ), - }); - room.disconnect(); - } - }, 10_000); - - return () => clearTimeout(timeout); - } - }, [agentState, sessionStarted, room]); - - // Minimal capabilities - only microphone control - const capabilities = { - supportsChatInput: false, - supportsVideoInput: false, - supportsScreenShare: false, - }; - - // Only show microphone control - const controls = { - microphone: true, - camera: false, - screenShare: false, - chat: false, - leave: false, - }; - - return ( -- Chat live with your voice AI agent -
- -- Need help getting set up? Check out the{' '} - - Voice AI quickstart - - . -
-- A quick start UI overview for the LiveKit Voice Assistant. -
-- A quick start UI overview for the LiveKit Voice Assistant. -
-