runspur 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mace
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# Runspur CLI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Runspur lets Codex and Claude Code delegate work to each other and sends results back to the conversation that started the task. This npm package contains the Windows x64 daemon, CLI, and MCP bridge as native executables.
+
+## Install
+
+With Node.js and npm installed, run the following in PowerShell.
+
+```powershell
+npm.cmd install --global runspur
+schedulerd.cmd --version
+schedulerctl.cmd --help
+scheduler-mcp.cmd --help
+```
+
+## Connect a project
+
+Start `schedulerd.cmd` in one terminal and keep it running. In another terminal, point the CLI at an existing project folder. Review the first command's preview, then save with `--apply`.
+
+```powershell
+$project = 'D:\path\your-project'
+schedulerctl.cmd configure --project-root $project --main-agent codex
+schedulerctl.cmd configure --project-root $project --main-agent codex --apply
+schedulerctl.cmd doctor --project-root $project
+```
+
+Open a new conversation in the configured host so it can discover the Skill and MCP tools. Automatic result delivery is verified on the supported Codex desktop distribution and on native Claude Code CLI sessions. Claude Code requires version 2.1.319 or later. Claude Desktop is untested.
+
+The default `probe` worker is for diagnostics. Set `--workers claude-cli` to use an installed Claude Code worker with a Codex main Agent. To switch roles, use `--main-agent claude-code --workers codex-cli`. Worker access starts read-only. With a supported Claude Code worker, use `--permission workspace-write` for task-specific files or `--permission project-write` for text files across the isolated project workspace. Preview and apply edits with `configure`.
+
+Use `schedulerctl.cmd projects`, `sessions --project <project-id>`, and `tasks --project <project-id>` to locate a dispatch. Use `schedulerctl.cmd task <task-id>` to inspect its result and delivery status.
+
+Stop the Runspur processes before updating with `npm.cmd update --global runspur` or removing the package with `npm.cmd uninstall --global runspur`. Project settings and the Runspur state directory are stored separately.
+
+[Full usage and source](https://github.com/ohmacemace/runspur) · [简体中文](https://github.com/ohmacemace/runspur/blob/main/docs/README.zh-CN.md)