Add README to all crates

2026-04-11 03:07:56 +09:00
parent 4c3f81b4fa
commit 60505f206b
9 changed files with 133 additions and 0 deletions
@@ -0,0 +1,10 @@
+# protocol
+
+クライアントとPod間の通信プロトコルを定義するクレート。Unix ソケット上で JSON Lines として送受信されるメッセージ型を提供する。
+
+## 公開型
+
+- `Method` — クライアント→Pod のコマンド（`Run`, `Resume`, `Cancel`）
+- `Event` — Pod→クライアント のイベント（`TurnStart`, `TextDelta`, `ToolCallStart`, `Usage`, `Error` など）
+- `TurnResult` — ターン完了状態（`Finished`, `Paused`）
+- `ErrorCode` — エラー分類（`AlreadyRunning`, `ProviderError`, `ToolError` など）