Skip to content

Commit ef77c29

Browse files
docs: note major overhaul in progress in README
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
1 parent 1903365 commit ef77c29

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @factory/droid-sdk
22

3+
> **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.
4+
35
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.
46

57
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.

0 commit comments

Comments
 (0)