From 28370e4b2a371744bbc06d7d094069d7d6a85fc5 Mon Sep 17 00:00:00 2001
From: jknapp <jknapp85@gmail.com>
Date: Sun, 23 Mar 2025 20:17:14 -0700
Subject: [PATCH] update the README.md

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 53 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f60b309..6b6260a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,54 @@
-# OWUI-Mult-Agent-Processing
+# OWUI-Multi-Agent-Collaboration
 
-Use OWUI Functions to pass request and information to multiple Agents
\ No newline at end of file
+A powerful pipe function for Open WebUI that enables collaboration between multiple AI models as agents.
+
+[TOC]
+
+## Overview
+
+OWUI-Multi-Agent-Processing (v0.5.3) allows you to leverage the strengths of different language models by having them work together on the same prompt. The system functions as a pipeline where each agent processes the input sequentially, and a final operator model synthesizes all the agent responses.
+
+## Features
+
+- **Multiple Agent Support**: Chain multiple language models together to work on the same task
+- **Sequential Processing**: Each agent's response is added to the conversation context for the next agent
+- **Operator Model**: A designated model synthesizes all agent responses to produce a final answer
+- **Customizable Configuration**: Choose which models to use as agents and which to use as the operator
+
+## How It Works
+
+1. User sends a prompt to the system
+2. The prompt is sequentially processed through each model in the agent list
+3. Each agent's response is appended to the conversation context
+4. The operator model (Claude 3.5 Sonnet by default) receives the enriched context with all agent responses
+5. The operator synthesizes a final response that is returned to the user
+
+## Installation
+
+1. Ensure you have Open WebUI installed
+2. Navigate to `Admin Panel` -> `Functions`
+3. `Import Functions` then select the multi-agent-collaboration.py file
+4. Enable the new Function
+
+## Configuration
+
+Users can customize their experience with these configurable options:
+
+- `agent_list`: List of model IDs to use as processing agents
+- `operator_model`: Model ID for the final operator (default: "us.anthropic.claude-3-5-sonnet-20241022-v2:0")
+
+## Example Use Cases
+
+- **Research Analysis**: Have specialized models analyze different aspects of a research question
+- **Creative Collaboration**: Use different models for idea generation, refinement, and evaluation
+- **Decision Support**: Gather perspectives from different models before making a final recommendation
+
+## Requirements
+
+- Open WebUI installation
+- API access to the models you wish to use as agents (if needed)
+
+## Limitations
+
+- Each additional agent increases token usage and processing time
+- Models must be available through your Open WebUI configuration
\ No newline at end of file