Skip to content

README hero: badges, install, before/after demos - #10

Merged
KMdotcom merged 1 commit into
mainfrom
cursor/readme-hero-886c
Jul 22, 2026
Merged

README hero: badges, install, before/after demos#10
KMdotcom merged 1 commit into
mainfrom
cursor/readme-hero-886c

Conversation

@KMdotcom

Copy link
Copy Markdown
Owner

Summary

Restructures the top of the README so new visitors see credibility and value before architecture.

Changes

  • PyPI version + CI badges
  • One-sentence problem statement (not implementation jargon)
  • Prominent pip install agent-handoff-kit (+ [openai] extra)
  • Without vs with trimmed terminal output from demo_without_relay.py / demo_with_relay.py
  • Alpha / positioning moved below a horizontal rule; Install section deduped (footgun + editable only)

PyPI

No version bump in this PR (README-only on GitHub). Optional 0.1.1 upload after merge if you want PyPI project page to match.

Open in Web Open in Cursor 

Lead with problem statement, pip install, and contrast demos before
architecture; add PyPI and CI badges.

Co-authored-by: KMdotcom <KMdotcom@users.noreply.github.com>
@KMdotcom
KMdotcom marked this pull request as ready for review July 22, 2026 08:12
@KMdotcom
KMdotcom merged commit b837831 into main Jul 22, 2026
2 checks passed
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