Skip to content

Commit 3a7f83b

Browse files
Update README.md
1 parent 3f651f6 commit 3a7f83b

File tree

1 file changed

+36
-44
lines changed

1 file changed

+36
-44
lines changed

README.md

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
1-
[![AG-UI Workshop – June 20](https://img.shields.io/badge/AG--UI%20Workshop%20%E2%80%94June%2020-blue?style=flat-square)](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)
2-
![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)
1+
32

43

54
# <img src="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058" alt="ag-ui Logo" height="42px" /> AG-UI: The Agent-User Interaction Protocol
65
AG-UI is a lightweight, event-based protocol that standardizes how AI agents connect to front-end applications. Built for simplicity and flexibility, it enables seamless integration between your AI agents and user interfaces.
76

8-
![AG-UI](https://github.com/user-attachments/assets/bec3bc01-d8f2-4667-885e-028cbcbc8439)
7+
[![Version](https://img.shields.io/npm/v/@ag-ui/core?label=Version&color=6963ff&logo=npm&logoColor=white)](https://www.npmjs.com/package/@ag-ui/core)
8+
![MIT](https://img.shields.io/github/license/copilotkit/copilotkit?color=%236963ff&label=License)
9+
![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)
10+
11+
![Banner](https://github.com/user-attachments/assets/c92ee75a-d8c5-42f3-aa42-d4511fdc935a)
912

13+
## 🚀 Getting Started
14+
Create a new AG-UI application in seconds:
15+
```ts
16+
npx create-ag-ui-app my-agent-app
17+
```
18+
<h3>Building AG-UI Integrations (new frameworks):</h3>
1019

11-
<img src="./assets/banner.png" alt="ag-ui Logo" style="width: 100%; height: auto;" />
20+
- [Build new integrations (Quickstart)]()
21+
- [Book a call to discuss an AG-UI integration with a new framework]()
22+
- [Join the Discord Community]()
1223

13-
# What is AG-UI? (Specification)
24+
## What is AG-UI?
1425

1526
AG-UI is an open, lightweight, event-based protocol for agent-human interaction, designed for simplicity & flexibility:
1627

@@ -25,7 +36,7 @@ AG-UI is an open, lightweight, event-based protocol for agent-human interaction,
2536
It also ships with a **reference HTTP implementation** and **default connector** to help teams get started fast.
2637

2738

28-
[Learn more about the specs](https://go.copilotkit.ai/ag-ui-introduction)
39+
[Learn more about the specs](https://go.copilotkit.ai/ag-ui-introduction)
2940

3041

3142
## Why AG-UI?
@@ -37,12 +48,8 @@ AG-UI is complementary to the other 2 top agentic protocols
3748
- MCP gives agents tools
3849
- A2A allows agents to communicate with other agents
3950
- AG-UI brings agents into user-facing applications
40-
41-
<div align="center">
42-
<img src="https://github.com/user-attachments/assets/0c1ec566-050b-4ef8-ab89-15be41abe64f" height="300px" />
43-
</div>
4451

45-
## Features
52+
## 🚀 Features
4653

4754
- 💬 Real-time agentic chat with streaming
4855
- 🔄 Bi-directional state synchronization
@@ -51,19 +58,19 @@ AG-UI is complementary to the other 2 top agentic protocols
5158
- 🛠️ Frontend tool integration
5259
- 🧑‍💻 Human-in-the-loop collaboration
5360

54-
## Framework Support
61+
## 🛠 Supported Frameworks
5562

5663
AG-UI integrates with many popular agent frameworks
5764

5865
| Framework | Status | AG-UI Resources |
5966
| ------------------------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------- |
6067
| No-framework | ✅ Supported | ➡️ Docs coming soon |
61-
| [LangGraph](https://www.langchain.com/langgraph) | ✅ Supported | ➡️ [Demo](https://v0-langgraph-land.vercel.app/) |
62-
| [Mastra](https://mastra.ai/) | ✅ Supported | ➡️ [Demo](https://v0-mastra-land.vercel.app/) |
63-
| [CrewAI](https://crewai.com/) | ✅ Supported | ➡️ [Demo](https://v0-crew-land.vercel.app/) |
64-
| [AG2](https://ag2.ai/) | ✅ Supported | ➡️ [Demo](https://v0-ag2-land.vercel.app/) |
65-
| [Agno](https://github.com/agno-agi/agno) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/agno) | |
66-
| [LlamaIndex](https://github.com/run-llama/llama_index) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/llamaindex) | |
68+
| [LangGraph](https://www.langchain.com/langgraph) | ✅ Supported | ➡️ [Demo](https://v0-langgraph-land.vercel.app/) |
69+
| [Mastra](https://mastra.ai/) | ✅ Supported | ➡️ [Demo](https://v0-mastra-land.vercel.app/) |
70+
| [CrewAI](https://crewai.com/) | ✅ Supported | ➡️ [Demo](https://v0-crew-land.vercel.app/) |
71+
| [AG2](https://ag2.ai/) | ✅ Supported | ➡️ [Demo](https://v0-ag2-land.vercel.app/) |
72+
| [Agno](https://github.com/agno-agi/agno) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/agno) | |
73+
| [LlamaIndex](https://github.com/run-llama/llama_index) | ✅ Supported | ➡️ [Docs](https://docs.copilotkit.ai/llamaindex) | |
6774
| [Pydantic AI](https://github.com/pydantic/pydantic-ai) | 🛠️ In Progress ||
6875
| [Vercel AI SDK](https://github.com/vercel/ai) | 🛠️ In Progress ||
6976
| [OpenAI Agent SDK](https://openai.github.io/openai-agents-python/) | 💡 Open to Contributions ||
@@ -81,48 +88,33 @@ AG-UI integrates with many popular agent frameworks
8188

8289
[View all supported frameworks →](https://ag-ui.com/frameworks)
8390

84-
## AG-UI Hello World
91+
## ✨ Hello World App
92+
93+
https://agui-demo.vercel.app/
8594

8695
https://github.com/user-attachments/assets/419e4b8c-09f1-4cf0-b76b-339c7a207584
8796

8897

89-
## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
98+
## 🧩 AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
9099
The [AG-UI Dojo](https://copilotkit-feature-viewer.vercel.app/) showcases many of the building blocks that AG-UI supports ([AG-UI Dojo Source Code](https://github.com/ag-ui-protocol/ag-ui/tree/main/typescript-sdk/apps/dojo)).
91100

92101
The building blocks are designed to be simple and focused -- between 50-200 lines of code.
93102

94103
[Video:](https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae)
95104

96-
## Getting Started
97-
98-
Choose your path:
99-
100-
### Building AG-UI Powered Applications
101-
102-
Create a new AG-UI application in seconds:
103-
104-
```bash
105-
npx create-ag-ui-app my-agent-app
106-
```
107-
108-
[View Documentation](https://go.copilotkit.ai/ag-ui-introduction) · [Join Discord](https://discord.gg/Jd3FzfdJa8)
109-
110-
### Building AG-UI Integrations (new frameworks)
111-
112-
1. [Build new integrations (Quickstart)](https://go.copilotkit.ai/build-quickstart)
113-
2. [Book a call to discuss an AG-UI integration with a new framework](https://go.copilotkit.ai/ag-ui-book-a-call)
114-
3. [Join the Discord Community](https://go.copilotkit.ai/AG-UI-Discord)
115-
116-
117-
## Contributing
118105

106+
## 🙋🏽‍♂️ Contributing to AG-UI
119107

120108
Check out the [Contributing guide](https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md)
121109

122110
- **[AG-UI: Build an agent canvas with AG-UI](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)**
123111
📅 Friday, June 20, 9:00 AM PT
124112

125113

126-
## License
114+
## 📄 License
115+
116+
AG-UI is open source software [licensed as MIT](https://opensource.org/licenses/MIT).
117+
Maintained by [AG Protocol](https://www.agprotocol.ai).
118+
119+
127120

128-
AG-UI is open source and available under the MIT License.

0 commit comments

Comments
 (0)