From 56b6390b98bebbce7a84f4a377010c2aa1c24446 Mon Sep 17 00:00:00 2001
From: Adi <adisingh@umich.edu>
Date: Tue, 31 Mar 2026 06:06:57 +0000
Subject: [PATCH] =?UTF-8?q?Improve=20root=20README=20=E2=80=94=20add=20fra?=
 =?UTF-8?q?mework=20table,=20quick=20start=20examples,=20badges,=20links?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 65 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 1c4efca..6c3fd3a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,69 @@
 # AgentMail Toolkit
 
-The AgentMail Toolkit integrates popular agent frameworks and protocols including OpenAI Agents SDK, Vercel AI SDK, and Model Context Protocol (MCP) with the AgentMail API.
+[![npm](https://img.shields.io/npm/v/agentmail-toolkit)](https://www.npmjs.com/package/agentmail-toolkit)
+[![pypi](https://img.shields.io/pypi/v/agentmail-toolkit)](https://pypi.org/project/agentmail-toolkit)
 
-## Setup & Usage
+Pre-built integrations that connect popular AI agent frameworks to the [AgentMail](https://agentmail.to) email API. Give your agents their own email inboxes in minutes.
 
-See the [Python](/python) and [Node](/node) packages for language specific setup and usage.
+## Supported Frameworks
+
+| Framework | Python | TypeScript |
+|---|---|---|
+| [OpenAI Agents SDK](https://github.com/openai/openai-agents-python) | ✓ | — |
+| [Vercel AI SDK](https://sdk.vercel.ai) | — | ✓ |
+| [Model Context Protocol (MCP)](https://modelcontextprotocol.io) | ✓ | ✓ |
+
+## Quick Start
+
+### TypeScript (Vercel AI SDK)
+
+```bash
+npm install agentmail-toolkit
+export AGENTMAIL_API_KEY=am_us_xxx
+```
+
+```typescript
+import { openai } from "@ai-sdk/openai";
+import { AgentMailToolkit } from "agentmail-toolkit/ai-sdk";
+import { streamText } from "ai";
+
+const result = streamText({
+  model: openai("gpt-4o"),
+  messages,
+  system: "You are an email agent that can create inboxes, send, and receive emails.",
+  tools: new AgentMailToolkit().getTools(),
+});
+```
+
+### Python (OpenAI Agents SDK)
+
+```bash
+pip install agentmail-toolkit
+export AGENTMAIL_API_KEY=am_us_xxx
+```
+
+```python
+from agentmail_toolkit.openai import AgentMailToolkit
+from agents import Agent
+
+agent = Agent(
+    name="Email Agent",
+    instructions="You are an agent that can send, receive, and manage emails.",
+    tools=AgentMailToolkit().get_tools(),
+)
+```
+
+## Packages
+
+| Package | Directory | Docs |
+|---|---|---|
+| [`agentmail-toolkit`](https://www.npmjs.com/package/agentmail-toolkit) (npm) | [`/node`](./node) | [Node README](./node/README.md) |
+| [`agentmail-toolkit`](https://pypi.org/project/agentmail-toolkit) (PyPI) | [`/python`](./python) | [Python README](./python/README.md) |
+
+## Links
+
+- [AgentMail](https://agentmail.to) — The email API for AI agents
+- [Documentation](https://docs.agentmail.to)
+- [Examples](https://github.com/agentmail-to/agentmail-examples)
+- [MCP Server](https://github.com/agentmail-to/agentmail-mcp)
+- [Discord](https://discord.gg/ZYN7f7KPjS)