Update README.md

README.md

@@ -11,4 +11,61 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Project Charles
+
+Toy app for voice based agent
+
+Video Demo -> [Early Test](https://www.linkedin.com/posts/sohojoe_ray-vosk-chatgpt-activity-7100365711226671104-c2Nv?utm_source=share&utm_medium)
+
+## Required Environment Variables/Keys
+
+* OPENAI_API_KEY - required for ChatGPT
+* ELEVENLABS_API_KEY - required for ElevenLabs TTS
+
+## Optional Environment Variables/Keys
+
+* TWILIO_ACCOUNT_SID - reduces time for WebRTC connection
+* TWILIO_AUTH_TOKEN - reduces time for WebRTC connection
+
+## How to install
+
+```bash
+pip install -r requirements.txt
+```
+
+Install packages from packages.txt
+
+macOS (Homebrew)
+```bash 
+xargs brew install < packages.txt
+```
+
+Linux (Ubuntu, apt)
+```bash
+sudo xargs -a packages.txt apt-get install -y
+```
+
+Linux (Fedora, dnf)
+```bash
+sudo xargs -a packages.txt dnf install -y
+```
+
+Windows (Chocolatey)
+```bash
+Get-Content packages.txt | ForEach-Object { choco install $_ -y }
+```
+
+
+
+## How to run
+
+```bash
+streamlit run app.py
+```
+
+## Known Issues
+
+* First run maybe slow due to downloading of model. You may want to refresh the page after the first run.
+* Audio errors may occur due to the way the app converts from ElevenLabs stream to WebRTC audio
+* Audio error may happen if the server is running slow
+* May hang and server needs a hard reset