Skip to content

Commit

Permalink
Some addition links and README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
markbackman committed Jan 12, 2025
1 parent a04a920 commit 4c0861c
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 8 deletions.
22 changes: 18 additions & 4 deletions examples/simple-chatbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img src="image.png" width="420px">

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

Expand All @@ -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)

Expand All @@ -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:
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions examples/simple-chatbot/client/javascript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions examples/simple-chatbot/client/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 4c0861c

Please sign in to comment.