Skip to content

Commit 8e90ce6

Browse files
Merge pull request #118 from juanpabloCamus/litebox-readme-update
update readme
2 parents fa3c953 + fec7893 commit 8e90ce6

File tree

1 file changed

+42
-36
lines changed

1 file changed

+42
-36
lines changed

README.md

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
[![AG-UI Working Group – July 17](https://img.shields.io/badge/AG--UI%20Working_Group%20%E2%80%94July%2017-blue?style=flat-square)](https://lu.ma/743wdv06)
2-
![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)
3-
41

52
# <img src="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058" alt="ag-ui Logo" width="45"/> AG-UI: The Agent-User Interaction Protocol
3+
64
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.
75

8-
![AG-UI](https://github.com/user-attachments/assets/bec3bc01-d8f2-4667-885e-028cbcbc8439)
6+
[![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)
7+
![MIT](https://img.shields.io/github/license/copilotkit/copilotkit?color=%236963ff&label=License)
8+
![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)
9+
10+
![Banner](https://github.com/user-attachments/assets/c92ee75a-d8c5-42f3-aa42-d4511fdc935a)
11+
12+
## 🚀 Getting Started
13+
Create a new AG-UI application in seconds:
14+
```ts
15+
npx create-ag-ui-app my-agent-app
16+
```
17+
<h3>Building AG-UI Integrations (new frameworks):</h3>
918

19+
- [Build new integrations (Quickstart)](https://go.copilotkit.ai/agui-contribute)
20+
- [Book a call to discuss an AG-UI integration with a new framework](https://calendly.com/markus-copilotkit/ag-ui)
21+
- [Join the Discord Community](https://discord.gg/Jd3FzfdJa8)
1022

11-
# What is AG-UI? (Specification)
23+
## What is AG-UI?
1224

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

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

2537

26-
[Learn more about the specs](https://go.copilotkit.ai/ag-ui-introduction)
38+
[Learn more about the specs](https://go.copilotkit.ai/ag-ui-introduction)
2739

2840

2941
## Why AG-UI?
@@ -32,6 +44,12 @@ AG-UI was developed based on real-world requirements and practical experience bu
3244

3345

3446

47+
## Where does AGUI fit in the agentic protocol stack?
48+
AG-UI is complementary to the other 2 top agentic protocols
49+
- MCP gives agents tools
50+
- A2A allows agents to communicate with other agents
51+
- AG-UI brings agents into user-facing applications
52+
3553
## Where does AGUI fit in the agentic protocol stack?
3654
AG-UI is complementary to the other 2 top agentic protocols
3755
- MCP gives agents tools
@@ -42,7 +60,7 @@ AG-UI is complementary to the other 2 top agentic protocols
4260
<img src="https://github.com/user-attachments/assets/0c1ec566-050b-4ef8-ab89-15be41abe64f" height="300px" />
4361
</div>
4462

45-
## Features
63+
## 🚀 Features
4664

4765
- 💬 Real-time agentic chat with streaming
4866
- 🔄 Bi-directional state synchronization
@@ -53,7 +71,8 @@ AG-UI is complementary to the other 2 top agentic protocols
5371

5472
### 1st party integrations with top agentic frameworks
5573

56-
## Framework Support
74+
## 🛠 Supported Frameworks
75+
5776

5877
AG-UI integrates with many popular agent frameworks
5978

@@ -83,52 +102,39 @@ AG-UI integrates with many popular agent frameworks
83102

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

86-
## Hello World App
87-
https://agui-demo.vercel.app/
105+
106+
## ✨ Hello World App
107+
88108

89109
Video:
90110

91111
https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae
92112

113+
https://agui-demo.vercel.app/
114+
93115

94-
## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
116+
117+
## 🧩 AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
95118
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)).
96119

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

99122
https://github.com/user-attachments/assets/a67d3d54-36b2-4c7a-ac69-a0ca01365d5b
100123

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

125+
## 🙋🏽‍♂️ Contributing to AG-UI
124126

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

129+
- **[Weekely AG-UI Working Group](https://lu.ma/CopilotKit?k=c)**
130+
📅 Follow the CopilotKit Luma Events Page
131+
127132
## Roadmap
128133

129-
Check out the [AG-UI Roadmap](https://github.com/orgs/ag-ui-protocol/projects/1)
134+
Check out the [AG-UI Roadmap](https://github.com/orgs/ag-ui-protocol/projects/1) to see what's being built and where you can jump in.
130135

131136

132-
## License
137+
## 📄 License
133138

134-
AG-UI is open source and available under the MIT License.
139+
AG-UI is open source software [licensed as MIT](https://opensource.org/licenses/MIT).
140+
Maintained by [AG Protocol](https://www.agprotocol.ai).

0 commit comments

Comments
 (0)