Update README with comprehensive SDK overview and current features #1168
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.
Update README with comprehensive SDK overview and current features
Summary
Updated the main README.md to provide a more comprehensive overview of the Codegen SDK, highlighting both AI agent capabilities and programmatic codebase manipulation features. The changes transform the README from a simple agent API introduction to a complete project overview covering three primary use cases: AI Code Agents, Codebase SDK, and SWE-Bench Evaluation.
Key changes include:
Review & Testing Checklist for Human
Codebase.from_repo(),codebase.functions, etc.)Recommended test plan: Clone a fresh copy of the repository and follow the installation and getting started instructions step-by-step to ensure they work for new users.
Diagram
%%{ init : { "theme" : "default" }}%% graph TD README["README.md"]:::major-edit pyproject["pyproject.toml"]:::context contrib["CONTRIBUTING.md"]:::context agents_readme["src/codegen/agents/README.md"]:::context docs_site["docs.codegen.com"]:::context README --> pyproject README --> contrib README --> agents_readme README --> docs_site pyproject -.->|"Python version requirements"| README contrib -.->|"uv installation method"| README agents_readme -.->|"Agent API examples"| README docs_site -.->|"Documentation links"| README subgraph Legend L1[Major Edit]:::major-edit L2[Minor Edit]:::minor-edit L3[Context/No Edit]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes