runspur 0.0.0-stage → 0.1.2

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,38 @@
-# 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. The Windows x64 npm package includes the Runspur CLI, scheduler, MCP bridge, and local browser panel.
+
+## Install
+
+With Node.js and npm installed, run the following in PowerShell.
+
+```powershell
+npm install --global runspur
+runspur --version
+```
+
+If PowerShell blocks script shims, use `npm.cmd` and `runspur.cmd`.
+
+## Open the panel
+
+Run the following to open the panel in your browser. Runspur starts the local scheduler as needed.
+
+```powershell
+runspur tui
+```
+
+In **Projects**, add an existing folder and select the main Agent, child Agents, and file permissions. Review the configuration and confirm to connect the project. Open a new conversation in the configured host to load the project's 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.
+
+For headless use, run `runspur start` to start the scheduler in the background and `runspur stop` to stop it. Each command returns when the scheduler reaches the requested state.
+
+## Manage projects and dispatches
+
+Use **Projects** to edit the Agents or permissions of a connected project. Worker access defaults to read-only. Use Claude Code **2.1.319** for workers that need permission to edit task-specific files or text files across the isolated project workspace.
+
+Use **Dispatch history** to find tasks by project and conversation, then inspect their results and delivery status.
+
+Before uninstalling, finish active tasks and close connected Agent conversations. Stop the scheduler from **Overview** or run `runspur stop`. If the panel is open, press Ctrl+C in the `runspur tui` terminal to close it. Then run `npm 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)