Skip to content

docs: improve README with better description, badges, and usage examples#31

Open
Arvuno wants to merge 1 commit into
agentmail-to:mainfrom
Arvuno:improve-readme
Open

docs: improve README with better description, badges, and usage examples#31
Arvuno wants to merge 1 commit into
agentmail-to:mainfrom
Arvuno:improve-readme

Conversation

@Arvuno
Copy link
Copy Markdown

@Arvuno Arvuno commented May 25, 2026

Summary

Improve README with better description, badges, and usage examples.

Changes

  • Enhanced project description with clear value proposition
  • Added license badge
  • Added framework compatibility table
  • Added quick start examples for Python (OpenAI Agents SDK) and Node (Vercel AI SDK)
  • Documented agent capabilities (create inboxes, send/read emails, manage attachments)
  • Added links to documentation and related repositories

Testing

  • Docs render correctly on GitHub
  • Code examples are accurate

Summary by cubic

Improved README with a clearer value prop, MIT license badge, supported frameworks table, and quick-start examples for Python (OpenAI Agents SDK) and Node (Vercel AI SDK). Added a capabilities overview (inboxes, send/read/reply, attachments) plus links to docs and related repos to make setup easier.

Written for commit f48401a. Summary will update on new commits. Review in cubic

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.

2 participants