Rename examples files, update quickstart

examples/quickstart/README.md

@@ -1,14 +1,52 @@
-## Quickstart - TBD TBD TBD TBD
+# Pipecat Quickstart
 
-### Setup
+Run your first Pipecat bot in under 5 minutes. This example creates a voice AI bot that you can talk to in your browser.
 
-1. Set up a venv
+## Prerequisites
+
+### Python 3.10+
+
+Pipecat requires Python 3.10 or newer. Check your version:
+
+```bash
+python --version
+```
+
+If you need to upgrade Python, we recommend using a version manager like `uv` or `pyenv`.
+
+### AI Service API keys
+
+Pipecat orchestrates different AI services in a pipeline, ensuring low latency communication. In this quickstart example, we'll use:
+
+- [Deepgram](https://console.deepgram.com/signup) for Speech-to-Text transcriptions
+- [OpenAI](https://auth.openai.com/create-account) for LLM inference
+- [Cartesia](https://play.cartesia.ai/sign-up) for Text-to-Speech audio generation
+
+Have your API keys ready. We'll add them to your `.env` shortly.
+
+## Setup
+
+1. Set up a virtual environment
+
+From the root directory of the `pipecat` repo, run:
+
+```bash
+cd examples/quickstart
+python -m venv .venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+```
+
+> Using `uv`? Create your venv using: `uv venv && source .venv/bin/activate`.
 
 2. Install packages
 
-pip install "pipecat-ai[webrtc,deepgram,openai,cartesia,silero]" \
- "pipecat-ai-small-webrtc-prebuilt" \
- "python-dotenv"
+Then, install the requirements:
+
+```bash
+pip install -r requirements.txt
+```
+
+> Using `uv`? Install requirements using: `uv pip install -r requirements.txt`.
 
 3. Configure environment variables
 
@@ -28,8 +66,25 @@ CARTESIA_API_KEY=your_cartesia_api_key
 
 4. Run the example
 
+Run your bot using:
+
 ```bash
 python bot.py
 ```
 
-Connect to your bot in a browser at http://localhost:7860
+> Using `uv`? Run your bot using: `uv run bot.py`.
+
+Connect to your bot in a browser at http://localhost:7860.
+
+> 💡 First run note: The initial startup may take ~10 seconds as Pipecat downloads required models, like the Silero VAD model.
+
+## Troubleshooting
+
+- **Browser permissions**: Make sure to allow microphone access when prompted by your browser.
+- **Connection issues**: If the WebRTC connection fails, first try a different browser. If that fails, make sure you don't have a VPN or firewall rules blocking traffic. WebRTC uses UDP to communicate.
+- **Audio issues**: Check that your microphone and speakers are working and not muted.
+
+## Next Steps
+
+- **Read the docs**: Check out [Pipecat's docs](https://docs.pipecat.ai/) for guides and reference information.
+- **Join Discord**: Join [Pipecat's Discord server](https://discord.gg/pipecat) to get help and learn about what others are building.