From 4c0861ce39546886e9361df8672e3a9bc6702624 Mon Sep 17 00:00:00 2001 From: Mark Backman Date: Sun, 12 Jan 2025 09:25:49 -0500 Subject: [PATCH] Some addition links and README changes --- examples/simple-chatbot/README.md | 22 +++++++++++++++---- .../client/javascript/README.md | 4 ++-- .../simple-chatbot/client/react/README.md | 4 ++-- 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/examples/simple-chatbot/README.md b/examples/simple-chatbot/README.md index a2153abcf..89f83c8df 100644 --- a/examples/simple-chatbot/README.md +++ b/examples/simple-chatbot/README.md @@ -2,7 +2,7 @@ -This repository demonstrates a simple AI chatbot with real-time audio/video interaction, implemented in three different ways. The bot server supports multiple AI backends, and you can connect to it using three different client approaches. +This repository demonstrates a simple AI chatbot with real-time audio/video interaction, implemented using different client and server options. The bot server supports multiple AI backends, and you can connect to it using five different client approaches. ## Two Bot Options @@ -15,7 +15,7 @@ This repository demonstrates a simple AI chatbot with real-time audio/video inte - Uses Google's Gemini Multimodal Live model - Requires Gemini API key -## Three Ways to Connect +## Five Client Options 1. **Daily Prebuilt** (Simplest) @@ -29,9 +29,19 @@ This repository demonstrates a simple AI chatbot with real-time audio/video inte - Good for learning the fundamentals 3. **React** + - Basic impelmentation using [Pipecat React SDK](https://docs.pipecat.ai/client/react/introduction) - Demonstrates the basic client principles with Pipecat React +4. **Android** + + - Basic implementation using [Pipecat Android SDK](https://docs.pipecat.ai/client/android/introduction) + - Demonstrates the basic client principles with Pipecat Android + +5. **iOS** + - Basic implementation using [Pipecat iOS SDK](https://docs.pipecat.ai/client/ios/introduction) + - Demonstrates the basic client principles with Pipecat iOS + ## Quick Start ### First, start the bot server: @@ -62,6 +72,8 @@ This repository demonstrates a simple AI chatbot with real-time audio/video inte ### Next, connect using your preferred client app: +- [Android Guide](client/android/README.md) +- [iOS Guide](client/ios/README.md) - [Daily Prebuilt](client/prebuilt/README.md) - [JavaScript Guide](client/javascript/README.md) - [React Guide](client/react/README.md) @@ -91,7 +103,9 @@ simple-chatbot/ │ ├── server.py # FastAPI server │ └── requirements.txt └── client/ # Client implementations - ├── prebuilt/ # Daily Prebuilt connection - ├── javascript/ # Pipecat JavaScript client + ├── android/ # Daily Android connection + ├── ios/ # Daily iOS connection + ├── javascript/ # Daily JavaScript connection + ├── prebuilt/ # Pipecat Prebuilt client └── react/ # Pipecat React client ``` diff --git a/examples/simple-chatbot/client/javascript/README.md b/examples/simple-chatbot/client/javascript/README.md index fdd97ce27..3b0c7f96e 100644 --- a/examples/simple-chatbot/client/javascript/README.md +++ b/examples/simple-chatbot/client/javascript/README.md @@ -6,10 +6,10 @@ Basic implementation using the [Pipecat JavaScript SDK](https://docs.pipecat.ai/ 1. Run the bot server. See the [server README](../../README). -2. Navigate to the `examples/javascript` directory: +2. Navigate to the `client/javascript` directory: ```bash -cd examples/javascript +cd client/javascript ``` 3. Install dependencies: diff --git a/examples/simple-chatbot/client/react/README.md b/examples/simple-chatbot/client/react/README.md index 892763d18..d6947aceb 100644 --- a/examples/simple-chatbot/client/react/README.md +++ b/examples/simple-chatbot/client/react/README.md @@ -6,10 +6,10 @@ Basic implementation using the [Pipecat React SDK](https://docs.pipecat.ai/clien 1. Run the bot server; see [README](../../README). -2. Navigate to the `examples/react` directory: +2. Navigate to the `client/react` directory: ```bash -cd examples/react +cd client/react ``` 3. Install dependencies: