Skip to content

Commit 8e29055

Browse files
ashwin-antclaude
andcommitted
Add migration section to README linking to changelog
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 59f4412 commit 8e29055

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

CHANGELOG.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Changelog
22

3-
All notable changes to the Claude Agent SDK will be documented in this file.
4-
5-
## 0.1.0 - 2025-09-29
3+
## 0.1.0
64

75
Introducing the Claude Agent SDK! The Claude Code SDK has been renamed to better reflect its capabilities for building AI agents across all domains, not just coding.
86

@@ -45,8 +43,6 @@ For full migration instructions, see our [migration guide](https://docs.claude.c
4543
- New guides for [Custom Tools](https://docs.claude.com/en/api/agent-sdk/custom-tools), [Permissions](https://docs.claude.com/en/api/agent-sdk/permissions), [Session Management](https://docs.claude.com/en/api/agent-sdk/sessions), and more
4644
- Complete [Python API reference](https://docs.claude.com/en/api/agent-sdk/python)
4745

48-
---
49-
5046
## 0.0.22
5147

5248
- Introduce custom tools, implemented as in-process MCP servers.

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pip install claude-agent-sdk
1010

1111
**Prerequisites:**
1212
- Python 3.10+
13-
- Node.js
13+
- Node.js
1414
- Claude Code: `npm install -g @anthropic-ai/claude-code`
1515

1616
## Quick Start
@@ -59,7 +59,7 @@ options = ClaudeAgentOptions(
5959
)
6060

6161
async for message in query(
62-
prompt="Create a hello.py file",
62+
prompt="Create a hello.py file",
6363
options=options
6464
):
6565
# Process tool use and results
@@ -271,6 +271,15 @@ See [examples/quick_start.py](examples/quick_start.py) for a complete working ex
271271

272272
See [examples/streaming_mode.py](examples/streaming_mode.py) for comprehensive examples involving `ClaudeSDKClient`. You can even run interactive examples in IPython from [examples/streaming_mode_ipython.py](examples/streaming_mode_ipython.py).
273273

274+
## Migrating from Claude Code SDK
275+
276+
If you're upgrading from the Claude Code SDK (versions < 0.1.0), please see the [CHANGELOG.md](CHANGELOG.md#010) for details on breaking changes and new features, including:
277+
278+
- `ClaudeCodeOptions``ClaudeAgentOptions` rename
279+
- Merged system prompt configuration
280+
- Settings isolation and explicit control
281+
- New programmatic subagents and session forking features
282+
274283
## License
275284

276285
MIT

0 commit comments

Comments
 (0)