diff --git a/examples/aiortc/video-transform/README.rst b/examples/aiortc/video-transform/README.rst index 531b0a8c9..7125e3e68 100644 --- a/examples/aiortc/video-transform/README.rst +++ b/examples/aiortc/video-transform/README.rst @@ -1,43 +1,59 @@ -# Video transform +# Video Transform -A Pipecat example demonstrating how to send and receive audio and video using SmallWebRTCTransport. -It also performs some image processing on the video frames using OpenCV. +A Pipecat example demonstrating how to send and receive audio and video using `SmallWebRTCTransport`. This project also applies image processing to video frames using OpenCV. -## Quick Start +## 🚀 Quick Start -### First, start the bot server: +### 1️⃣ Start the Bot Server -1. Navigate to the server directory: - ```bash - cd server - ``` -2. Create and activate a virtual environment: +#### 📂 Navigate to the Server Directory +```bash +cd server +``` + +#### 🔧 Set Up the Environment +1. Create and activate a virtual environment: ```bash python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate ``` -3. Install requirements: + +2. Install dependencies: ```bash pip install -r requirements.txt ``` -4. Copy env.example to .env and configure: - - Add your API keys -5. Start the server: - ```bash - python server.py - ``` -### Next, connect using the client app: +3. Configure environment variables: + - Copy `env.example` to `.env` + ```bash + cp env.example .env + ``` + - Add your API keys + +#### ▶️ Run the Server +```bash +python server.py +``` + +### 2️⃣ Connect Using the Client App For client-side setup, refer to the [JavaScript Guide](client/typescript/README.md). -## Important Note - +## ⚠️ Important Note Ensure the bot server is running before using any client implementations. -## Requirements +## 📌 Requirements -- Python 3.10+ -- Node.js 16+ (for JavaScript) -- Google API key -- Modern web browser with WebRTC support \ No newline at end of file +- Python **3.10+** +- Node.js **16+** (for JavaScript components) +- Google API Key +- Modern web browser with WebRTC support + +--- + +### 💡 Notes +- Ensure all dependencies are installed before running the server. +- Check the `.env` file for missing configurations. +- WebRTC requires a secure environment (HTTPS) for full functionality in production. + +Happy coding! 🎉 \ No newline at end of file diff --git a/examples/aiortc/voice-agent/README.rst b/examples/aiortc/voice-agent/README.rst index 899adc861..17bf165af 100644 --- a/examples/aiortc/voice-agent/README.rst +++ b/examples/aiortc/voice-agent/README.rst @@ -1,34 +1,54 @@ -# Video transform +# Voice Agent -A Pipecat example demonstrating the simplest way to create a voice agent with SmallWebRTCTransport. +A Pipecat example demonstrating the simplest way to create a voice agent using `SmallWebRTCTransport`. -## Quick Start +## 🚀 Quick Start -### First, start the bot server: +### 1️⃣ Start the Bot Server +#### 🔧 Set Up the Environment 1. Create and activate a virtual environment: ```bash python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate ``` -2. Install requirements: + +2. Install dependencies: ```bash pip install -r requirements.txt ``` -3. Copy env.example to .env and configure: - - Add your API keys -4. Start the server: + +3. Configure environment variables: + - Copy `env.example` to `.env` ```bash - python server.py + cp env.example .env ``` + - Add your API keys -### Next, connect using the client app: +#### ▶️ Run the Server +```bash +python server.py +``` -Visit http://localhost:7860 in your browser. +### 2️⃣ Connect Using the Client App -## Requirements +Open your browser and visit: +``` +http://localhost:7860 +``` -- Python 3.10+ -- Node.js 16+ (for JavaScript) -- Google API key -- Modern web browser with WebRTC support \ No newline at end of file +## 📌 Requirements + +- Python **3.10+** +- Node.js **16+** (for JavaScript components) +- Google API Key +- Modern web browser with WebRTC support + +--- + +### 💡 Notes +- Ensure all dependencies are installed before running the server. +- Check the `.env` file for missing configurations. +- WebRTC requires a secure environment (HTTPS) for full functionality in production. + +Happy coding! 🎉 \ No newline at end of file