doc: readme

This commit is contained in:
Timothy Jaeryang Baek 2024-12-25 02:56:16 -07:00
parent ca94e68e92
commit a4f5df535b

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# open-webui/bot
This repository provides an experimental boilerplate for building bots compatible with the **Open WebUI** "Channels" feature (introduced in version 0.5.0). It serves as a proof of concept to demonstrate bot-building capabilities while highlighting the potential of asynchronous communication enabled by Channels.
## ⚡ Key Highlights
- **Highly Experimental**: This is an early-stage project showcasing basic bot-building functionality. Expect major API changes in the future.
- **Extensible Framework**: Designed as a foundation for further development, with plans to enhance APIs, developer tooling, and usability.
- **Asynchronous Communication**: Leverages Open WebUI Channels for event-driven workflows.
## 🚧 Disclaimer
This project is an early-stage proof of concept. **APIs will break** and existing functionality may change as Open WebUI evolves to include native bot support. This repository is not production-ready and primarily serves experimental and exploratory purposes.
## 🎯 Future Vision
We aim to introduce improved APIs, enhanced developer tooling, and seamless native support for bots directly within Open WebUI. The ultimate goal is to make building bots easier, faster, and more intuitive.
---
Contributions, feedback, and experimentation are encouraged. Join us in shaping the future of bot-building on Open WebUI!