docs: redesign README for open-source launch#7
Merged
Conversation
Complete rewrite of README.md with production-quality presentation: - Hero section with badges, install command, and navigation links - Architecture diagram showing host/SDK relationship - Feature comparison table (what it does vs what makes it different) - Copy-paste quick start with full working example - Core concepts section: event stream, hosted tools, multi-turn, hooks - Built-in tools reference table - MCP integration examples (stdio + HTTP) - Subagent delegation overview - Session management API showcase - Collapsible hook reference (19 SDK-native + 7 host-bridged) - Event reference table - Repository architecture tree - Development commands Made-with: Cursor
- Hero banner: dark theme with gradient glow, circuit icon, feature pills - Architecture diagram: host/SDK layered view with tools, runtime, providers - Event flow timeline: visual stream event sequence with loop-back indicator - Feature grid: 8-card layout covering all major capabilities - Comparison chart: side-by-side vs other frameworks with check/cross marks - Quick start header: gradient accent bar section divider - README rewritten to integrate all SVG graphics with refined typography Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Motivation
The previous README was written as internal engineering documentation. This rewrite targets external developers evaluating the SDK — it should convey "this is powerful, easy to use, and production-ready" within the first 10 seconds of reading.
Test plan
Made with Cursor