Skip to content

Commit 0c2ebce

Browse files
committed
docs: fix README inaccuracies — config format, event names, version
- Fix crate version: 0.1 → 0.7 - Fix AgentEvent variant: ToolCall → ToolStart (matches actual enum) - Remove nonexistent default_provider/defaultProvider from config examples - Fix default_model format to "provider/model" (e.g., "anthropic/claude-sonnet-4-20250514") - Consolidate Config Options table: merge provider+model rows into single default_model row
1 parent baceadb commit 0c2ebce

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ All three languages follow the same pattern: `Agent.create(config)` → `agent.s
5555

5656
```toml
5757
[dependencies]
58-
a3s-code-core = "0.1"
58+
a3s-code-core = "0.7"
5959
```
6060

6161
```rust
@@ -82,7 +82,7 @@ let (mut rx, _handle) = session.stream("Refactor auth").await?;
8282
while let Some(event) = rx.recv().await {
8383
match event {
8484
AgentEvent::TextDelta { text } => print!("{text}"),
85-
AgentEvent::ToolCall { name, .. } => println!("[tool: {name}]"),
85+
AgentEvent::ToolStart { name, .. } => println!("[tool: {name}]"),
8686
AgentEvent::End { .. } => break,
8787
_ => {} // required: AgentEvent is #[non_exhaustive]
8888
}
@@ -168,8 +168,7 @@ HCL (preferred) or JSON. Auto-detected by file extension.
168168

169169
```hcl
170170
# === LLM (required) ===
171-
default_provider = "anthropic"
172-
default_model = "claude-sonnet-4-20250514"
171+
default_model = "anthropic/claude-sonnet-4-20250514"
173172
174173
# === Agent Behavior ===
175174
max_tool_rounds = 20 # default: 50
@@ -232,8 +231,7 @@ providers {
232231

233232
```json
234233
{
235-
"defaultProvider": "anthropic",
236-
"defaultModel": "claude-sonnet-4-20250514",
234+
"defaultModel": "anthropic/claude-sonnet-4-20250514",
237235
"maxToolRounds": 20,
238236
"thinkingBudget": 4096,
239237
"skillDirs": ["./skills"],
@@ -265,8 +263,7 @@ providers {
265263

266264
| Field | HCL | JSON | Type | Default |
267265
|-------|-----|------|------|---------|
268-
| Provider | `default_provider` | `defaultProvider` | `string` | — (required) |
269-
| Model | `default_model` | `defaultModel` | `string` | — (required) |
266+
| Default model | `default_model` | `defaultModel` | `string` | — (required, format: `"provider/model"`) |
270267
| Max tool rounds | `max_tool_rounds` | `maxToolRounds` | `int?` | `50` |
271268
| Thinking budget | `thinking_budget` | `thinkingBudget` | `int?` | `null` |
272269
| Skill dirs | `skill_dirs` | `skillDirs` | `string[]` | `[]` |

0 commit comments

Comments
 (0)