Skip to content

Commit e446554

Browse files
Pretify beginning. Add landing gif. (#28)
Co-authored-by: Hussein Mozannar <hssein.mzannar@gmail.com>
1 parent 644d12e commit e446554

File tree

3 files changed

+42
-13
lines changed

3 files changed

+42
-13
lines changed

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
1+
<div align="center">
2+
3+
<img src="frontend/src/assets/logo.svg" alt="Magentic-UI Logo" height="100">
4+
15
# Magentic-UI
6+
_Complete complex web tasks by combining real-time browser automation with transparent, human-in-the-loop control._
27

3-
<!-- ![Magentic-UI](./docs/magenticui.png) -->
4-
<p align="center">
5-
<img src="./docs/magenticui.png" alt="Magentic-UI" height="400">
6-
</p>
8+
</div>
9+
10+
<img src="./docs/landing.gif" loop=infinite>
11+
12+
Magentic-UI is a multi-agent system for automating complex web tasks. An Orchestrator coordinates four agents—WebSurfer, Coder, FileSurfer, and UserProxy—to handle browsing, coding, file management, and user feedback, all through a collaborative web interface. Here's how you can get started with Magentic-UI.
13+
14+
```bash
15+
python3 -m venv .venv
16+
source .venv/bin/activate
17+
pip install magentic-ui
18+
# export OPENAI_API_KEY=<YOUR API KEY>
19+
magentic ui --port 8081
20+
```
21+
22+
23+
24+
25+
## About Magentic-UI
726

8-
Magentic-UI is a multiagent system consisting of 5 agents - an Orchestrator that coordinates a team of 4 specialized agents:
27+
Magentic-UI is a multi-agent system consisting of 5 agents - an Orchestrator that coordinates a team of 4 specialized agents:
928

1029
- **WebSurfer**: Navigates the web, retrieves information, and interacts with websites
1130
- **Coder**: Writes and executes code to solve programming tasks
@@ -14,7 +33,13 @@ Magentic-UI is a multiagent system consisting of 5 agents - an Orchestrator that
1433

1534
Magentic-UI provides a web interface for users to interact with the system, submit tasks, and monitor progress.
1635

17-
## Process Flow
36+
## How does it work?
37+
38+
<p align="center">
39+
<img src="./docs/magenticui.png" alt="Magentic-UI" height="400">
40+
</p>
41+
42+
1843

1944
1. **Task Input**: The user submits a task that requires multiple steps to complete.
2045

docs/landing.gif

6.74 MB
Loading

uv.lock

Lines changed: 11 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)