From 5bfa70df604b3f4dd62ca9556d7c2a93b9e2744e Mon Sep 17 00:00:00 2001 From: User Date: Tue, 16 Jun 2026 11:34:09 -0700 Subject: [PATCH] docs: note major overhaul in progress in README Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com> --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 65704cb..2695c87 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # @factory/droid-sdk +> **Status: major overhaul in progress.** This SDK is undergoing a significant overhaul. This public repository will not be updated for the next couple of weeks while that work lands. After that, it will be upgraded to our first official stable release. In the meantime, APIs are subject to change and the code here may lag behind active development. + TypeScript SDK for the [Factory](https://factory.ai) Droid CLI. Provides a high-level API for interacting with Droid as a subprocess: one-shot prompts, streaming, multi-turn sessions, structured output, in-process MCP tools, and tool permission control. For in-depth documentation, see the [SDK usage guide](./docs/sdk-usage-guide.md). To control a long-running `droid` daemon over WebSocket (multiple concurrent sessions, remote machines), see the [daemon usage guide](./docs/daemon-usage-guide.md). Low-level JSON-RPC protocol types and schemas are available from the `@factory/droid-sdk/protocol` subpath export.