diff --git a/README.md b/README.md index f3e1f507d..e5f4b270a 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,6 @@ - **Business Agents** – customer intake, support bots, guided flows - **Complex Dialog Systems** – design logic with structured conversations -🧭 Looking to build structured conversations? Check out [Pipecat Flows](https://github.com/pipecat-ai/pipecat-flows) for managing complex conversational states and transitions. - -🔍 Looking for help debugging your pipeline and processors? Check out [Whisker](https://github.com/pipecat-ai/whisker), a real-time Pipecat debugger. - ## 🧠 Why Pipecat? - **Voice-first**: Integrates speech recognition, text-to-speech, and conversation handling @@ -30,40 +26,30 @@ - **Composable Pipelines**: Build complex behavior from modular components - **Real-Time**: Ultra-low latency interaction with different transports (e.g. WebSockets or WebRTC) -## 📱 Client SDKs +## 🌐 Pipecat Ecosystem -You can connect to Pipecat from any platform using our official SDKs: +### 📱 Client SDKs - - - - - - - - - - - -
- JavaScript - JavaScript - - React - React - - React Native - React Native -
- Swift - Swift - - Kotlin - Kotlin - - JavaScript - C++ -
+Building client applications? You can connect to Pipecat from any platform using our official SDKs: + +JavaScript | React | React Native | +Swift | Kotlin | C++ | ESP32 + +### 🧭 Structured conversations + +Looking to build structured conversations? Check out [Pipecat Flows](https://github.com/pipecat-ai/pipecat-flows) for managing complex conversational states and transitions. + +### 🪄 Beautiful UIs + +Want to build beautiful and engaging experiences? Checkout the [Voice UI Kit](https://github.com/pipecat-ai/voice-ui-kit), a collection of components, hooks and templates for building voice AI applications quickly. + +### 🔍 Debugging + +Looking for help debugging your pipeline and processors? Check out [Whisker](https://github.com/pipecat-ai/whisker), a real-time Pipecat debugger. + +### 🖥️ Terminal + +Love terminal applications? Check out [Tail](https://github.com/pipecat-ai/tail), a terminal dashboard for Pipecat. ## 🎬 See it in action @@ -184,54 +170,6 @@ Run a specific test suite: uv run pytest tests/test_name.py ``` -### Setting up your editor - -This project uses strict [PEP 8](https://peps.python.org/pep-0008/) formatting via [Ruff](https://github.com/astral-sh/ruff). - -#### Emacs - -You can use [use-package](https://github.com/jwiegley/use-package) to install [emacs-lazy-ruff](https://github.com/christophermadsen/emacs-lazy-ruff) package and configure `ruff` arguments: - -```elisp -(use-package lazy-ruff - :ensure t - :hook ((python-mode . lazy-ruff-mode)) - :config - (setq lazy-ruff-format-command "ruff format") - (setq lazy-ruff-check-command "ruff check --select I")) -``` - -`ruff` was installed in the `venv` environment described before, so you should be able to use [pyvenv-auto](https://github.com/ryotaro612/pyvenv-auto) to automatically load that environment inside Emacs. - -```elisp -(use-package pyvenv-auto - :ensure t - :defer t - :hook ((python-mode . pyvenv-auto-run))) -``` - -#### Visual Studio Code - -Install the -[Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) extension. Then edit the user settings (_Ctrl-Shift-P_ `Open User Settings (JSON)`) and set it as the default Python formatter, and enable formatting on save: - -```json -"[python]": { - "editor.defaultFormatter": "charliermarsh.ruff", - "editor.formatOnSave": true -} -``` - -#### PyCharm - -`ruff` was installed in the `venv` environment described before, now to enable autoformatting on save, go to `File` -> `Settings` -> `Tools` -> `File Watchers` and add a new watcher with the following settings: - -1. **Name**: `Ruff formatter` -2. **File type**: `Python` -3. **Working directory**: `$ContentRoot$` -4. **Arguments**: `format $FilePath$` -5. **Program**: `$PyInterpreterDirectory$/ruff` - ## 🤝 Contributing We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, here's how you can help: