From fb1c474ea6cfa339e2a8793d1fc9a2e6625192ee Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 28 Jan 2026 20:59:51 +0000 Subject: [PATCH] fix: add README files to platform packages and fix relative refs in main README - Add README.md to each platform package (@agent-rdp/darwin-arm64, darwin-x64, linux-arm64, linux-x64, win32-arm64, win32-x64) that points users to the main agent-rdp package - Update package.json files to include README.md in published files - Fix relative doc links in root README.md to use absolute GitHub URLs so they work when the README is copied to packages/agent-rdp during npm publish https://claude.ai/code/session_01X9GrLX4PVdbbpcQ8pATH4Q --- README.md | 4 ++-- packages/darwin-arm64/README.md | 17 +++++++++++++++++ packages/darwin-arm64/package.json | 3 ++- packages/darwin-x64/README.md | 17 +++++++++++++++++ packages/darwin-x64/package.json | 3 ++- packages/linux-arm64/README.md | 17 +++++++++++++++++ packages/linux-arm64/package.json | 3 ++- packages/linux-x64/README.md | 17 +++++++++++++++++ packages/linux-x64/package.json | 3 ++- packages/win32-arm64/README.md | 17 +++++++++++++++++ packages/win32-arm64/package.json | 3 ++- packages/win32-x64/README.md | 17 +++++++++++++++++ packages/win32-x64/package.json | 3 ++- 13 files changed, 116 insertions(+), 8 deletions(-) create mode 100644 packages/darwin-arm64/README.md create mode 100644 packages/darwin-x64/README.md create mode 100644 packages/linux-arm64/README.md create mode 100644 packages/linux-x64/README.md create mode 100644 packages/win32-arm64/README.md create mode 100644 packages/win32-x64/README.md diff --git a/README.md b/README.md index a7e0d62..d4f67d5 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ On the remote Windows machine, mapped drives appear in File Explorer as network Interact with Windows applications programmatically via the Windows UI Automation API using native patterns (InvokePattern, SelectionItemPattern, TogglePattern, etc.). When enabled, a PowerShell agent is injected into the remote session that captures the accessibility tree and performs actions. Communication between the CLI and the agent uses a Dynamic Virtual Channel (DVC) for fast bidirectional IPC. -For detailed documentation, see [docs/AUTOMATION.md](docs/AUTOMATION.md). +For detailed documentation, see [AUTOMATION.md](https://github.com/thisnick/agent-rdp/blob/main/docs/AUTOMATION.md). ```bash # Connect with automation enabled @@ -412,7 +412,7 @@ await rdp.connect({...}); const streamUrl = rdp.getStreamUrl(); // "ws://localhost:9224" ``` -For the complete WebSocket protocol specification (message types, clipboard flow, input handling), see [docs/WEBSOCKET.md](docs/WEBSOCKET.md). +For the complete WebSocket protocol specification (message types, clipboard flow, input handling), see [WEBSOCKET.md](https://github.com/thisnick/agent-rdp/blob/main/docs/WEBSOCKET.md). ## Architecture diff --git a/packages/darwin-arm64/README.md b/packages/darwin-arm64/README.md new file mode 100644 index 0000000..f045a5b --- /dev/null +++ b/packages/darwin-arm64/README.md @@ -0,0 +1,17 @@ +# @agent-rdp/darwin-arm64 + +Native binary package for macOS ARM64 (Apple Silicon). + +This is a platform-specific package that contains the native binary for agent-rdp. You should not install this package directly - instead, install the main package: + +```bash +npm install agent-rdp +``` + +The main package will automatically install the correct platform-specific binary for your system. + +For documentation, see the [agent-rdp README](https://github.com/thisnick/agent-rdp#readme). + +## License + +MIT OR Apache-2.0 diff --git a/packages/darwin-arm64/package.json b/packages/darwin-arm64/package.json index b6cdea7..aadeca2 100644 --- a/packages/darwin-arm64/package.json +++ b/packages/darwin-arm64/package.json @@ -16,7 +16,8 @@ ], "files": [ "bin", - "models" + "models", + "README.md" ], "scripts": { "postinstall": "chmod +x bin/agent-rdp 2>/dev/null || true" diff --git a/packages/darwin-x64/README.md b/packages/darwin-x64/README.md new file mode 100644 index 0000000..8798c67 --- /dev/null +++ b/packages/darwin-x64/README.md @@ -0,0 +1,17 @@ +# @agent-rdp/darwin-x64 + +Native binary package for macOS x64 (Intel). + +This is a platform-specific package that contains the native binary for agent-rdp. You should not install this package directly - instead, install the main package: + +```bash +npm install agent-rdp +``` + +The main package will automatically install the correct platform-specific binary for your system. + +For documentation, see the [agent-rdp README](https://github.com/thisnick/agent-rdp#readme). + +## License + +MIT OR Apache-2.0 diff --git a/packages/darwin-x64/package.json b/packages/darwin-x64/package.json index e2e3ccb..940e6e1 100644 --- a/packages/darwin-x64/package.json +++ b/packages/darwin-x64/package.json @@ -16,7 +16,8 @@ ], "files": [ "bin", - "models" + "models", + "README.md" ], "scripts": { "postinstall": "chmod +x bin/agent-rdp 2>/dev/null || true" diff --git a/packages/linux-arm64/README.md b/packages/linux-arm64/README.md new file mode 100644 index 0000000..a402319 --- /dev/null +++ b/packages/linux-arm64/README.md @@ -0,0 +1,17 @@ +# @agent-rdp/linux-arm64 + +Native binary package for Linux ARM64. + +This is a platform-specific package that contains the native binary for agent-rdp. You should not install this package directly - instead, install the main package: + +```bash +npm install agent-rdp +``` + +The main package will automatically install the correct platform-specific binary for your system. + +For documentation, see the [agent-rdp README](https://github.com/thisnick/agent-rdp#readme). + +## License + +MIT OR Apache-2.0 diff --git a/packages/linux-arm64/package.json b/packages/linux-arm64/package.json index 606c044..ef5408b 100644 --- a/packages/linux-arm64/package.json +++ b/packages/linux-arm64/package.json @@ -16,7 +16,8 @@ ], "files": [ "bin", - "models" + "models", + "README.md" ], "scripts": { "postinstall": "chmod +x bin/agent-rdp 2>/dev/null || true" diff --git a/packages/linux-x64/README.md b/packages/linux-x64/README.md new file mode 100644 index 0000000..f34a306 --- /dev/null +++ b/packages/linux-x64/README.md @@ -0,0 +1,17 @@ +# @agent-rdp/linux-x64 + +Native binary package for Linux x64. + +This is a platform-specific package that contains the native binary for agent-rdp. You should not install this package directly - instead, install the main package: + +```bash +npm install agent-rdp +``` + +The main package will automatically install the correct platform-specific binary for your system. + +For documentation, see the [agent-rdp README](https://github.com/thisnick/agent-rdp#readme). + +## License + +MIT OR Apache-2.0 diff --git a/packages/linux-x64/package.json b/packages/linux-x64/package.json index a25bc40..caad51f 100644 --- a/packages/linux-x64/package.json +++ b/packages/linux-x64/package.json @@ -16,7 +16,8 @@ ], "files": [ "bin", - "models" + "models", + "README.md" ], "scripts": { "postinstall": "chmod +x bin/agent-rdp 2>/dev/null || true" diff --git a/packages/win32-arm64/README.md b/packages/win32-arm64/README.md new file mode 100644 index 0000000..44023d5 --- /dev/null +++ b/packages/win32-arm64/README.md @@ -0,0 +1,17 @@ +# @agent-rdp/win32-arm64 + +Native binary package for Windows ARM64. + +This is a platform-specific package that contains the native binary for agent-rdp. You should not install this package directly - instead, install the main package: + +```bash +npm install agent-rdp +``` + +The main package will automatically install the correct platform-specific binary for your system. + +For documentation, see the [agent-rdp README](https://github.com/thisnick/agent-rdp#readme). + +## License + +MIT OR Apache-2.0 diff --git a/packages/win32-arm64/package.json b/packages/win32-arm64/package.json index a3b3a73..40d4af5 100644 --- a/packages/win32-arm64/package.json +++ b/packages/win32-arm64/package.json @@ -16,7 +16,8 @@ ], "files": [ "bin", - "models" + "models", + "README.md" ], "preferUnplugged": true } diff --git a/packages/win32-x64/README.md b/packages/win32-x64/README.md new file mode 100644 index 0000000..aef8693 --- /dev/null +++ b/packages/win32-x64/README.md @@ -0,0 +1,17 @@ +# @agent-rdp/win32-x64 + +Native binary package for Windows x64. + +This is a platform-specific package that contains the native binary for agent-rdp. You should not install this package directly - instead, install the main package: + +```bash +npm install agent-rdp +``` + +The main package will automatically install the correct platform-specific binary for your system. + +For documentation, see the [agent-rdp README](https://github.com/thisnick/agent-rdp#readme). + +## License + +MIT OR Apache-2.0 diff --git a/packages/win32-x64/package.json b/packages/win32-x64/package.json index bbd721e..faffa31 100644 --- a/packages/win32-x64/package.json +++ b/packages/win32-x64/package.json @@ -16,7 +16,8 @@ ], "files": [ "bin", - "models" + "models", + "README.md" ], "preferUnplugged": true }