diff --git a/README.md b/README.md index 26e7282..df9ea60 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,47 @@ Welcome to **Pipelines**, [Open WebUI](https://github.com/open-webui) initiative ## πŸ”§ How It Works +

+ Pipelines Workflow +

+ Integrating Pipelines with any OpenAI API-compatible UI client is a breeze. Simply launch your Pipelines instance and set the OpenAI URL on your client to the Pipelines URL. That's it! You're now ready to leverage any Python library, whether you want an agent to manage your home or need a custom pipeline for your enterprise workflow. +## πŸ“‚ Directory Structure and Examples + +Everything you need to build and extend Pipelines can be found in the `/pipelines` directory. This directory is the heart of your Pipelines setup, where you can add new modules, customize existing ones, and manage your workflow integrations. + +### Integration Examples + +To help you get started quickly, we've included a variety of integration examples in the `/pipeline/examples` directory. These examples demonstrate how to integrate different functionalities and libraries, providing a solid foundation for building your own custom pipelines. + +## πŸ“¦ Installation and Setup + +To get started with Pipelines, follow these simple steps: + +1. **Ensure you have Python 3.11 installed.** +2. **Clone the Pipelines repository:** + + ```sh + git clone https://github.com/open-webui/pipelines.git + cd pipelines + ``` + +3. **Install the required dependencies:** + + ```sh + pip install -r requirements.txt + ``` + +4. **Start the Pipelines server:** + ```sh + sh ./start.sh + ``` + +Once the server is running, you can set the OpenAI URL on your client to the Pipelines URL. This allows you to leverage the full capabilities of Pipelines, integrating any Python library and creating custom workflows tailored to your needs. + +Happy coding and welcome to the future of customizable AI integrations with **Pipelines**! + ## πŸŽ‰ Work in Progress We’re continuously evolving! We'd love to hear your feedback and understand which hooks and features would best suit your use case. Feel free to reach out and become a part of our Open WebUI community! diff --git a/docs/images/workflow.png b/docs/images/workflow.png new file mode 100644 index 0000000..2fe2347 Binary files /dev/null and b/docs/images/workflow.png differ