Skip to content

docs: enhance README with framework matrix, comparison table, and quick start examples#23

Open
adi-singh13 wants to merge 1 commit into
mainfrom
improve-readme-seo-v2
Open

docs: enhance README with framework matrix, comparison table, and quick start examples#23
adi-singh13 wants to merge 1 commit into
mainfrom
improve-readme-seo-v2

Conversation

@adi-singh13
Copy link
Copy Markdown

What this PR does

Transforms the README from a 7-line stub into a comprehensive, SEO-optimized landing page for the toolkit.

Changes:

  • Badges — PyPI, npm, and license badges for credibility signals
  • Framework matrix — Clear table showing OpenAI Agents SDK, Vercel AI SDK, and MCP support per language
  • Quick start examples — Copy-paste code for both Python and TypeScript
  • Capabilities section — What agents can do with the toolkit (create inboxes, send/receive, semantic search, etc.)
  • Comparison table — AgentMail vs Gmail API vs SendGrid vs Resend feature matrix
  • Examples links — Direct links to the best templates in agentmail-examples
  • Links section — All ecosystem repos linked

Why this matters:

This is the highest-star repo (71★) in the org. The README is the first thing developers see. A rich README:

  1. Increases GitHub search ranking (more keyword matches)
  2. Converts visitors into users (clear value prop + copy-paste examples)
  3. Captures comparison search intent ('agentmail vs resend', 'email api for agents')
  4. Shows framework compatibility at a glance

SEO keywords captured:

  • AI agent email
  • email inbox API
  • OpenAI Agents SDK email
  • Vercel AI SDK email
  • MCP email server
  • agent framework email integration

…ck start examples

- Add badges (PyPI, npm, license)
- Add supported frameworks matrix (OpenAI, Vercel AI SDK, MCP)
- Add quick start examples for both Python and TypeScript
- Add feature comparison table vs Gmail API, SendGrid, Resend
- Add capabilities section with emoji bullets
- Link to agentmail-examples templates
- Better SEO with descriptive headings and keywords
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant