Skip to content

fix: add README files to platform packages and fix relative refs in main README#65

Merged
thisnick merged 1 commit intomainfrom
claude/fix-package-readme-refs-HqYkq
Jan 28, 2026
Merged

fix: add README files to platform packages and fix relative refs in main README#65
thisnick merged 1 commit intomainfrom
claude/fix-package-readme-refs-HqYkq

Conversation

@thisnick
Copy link
Copy Markdown
Owner

Summary

This PR adds README files to all platform-specific binary packages and updates documentation links in the main README to use absolute GitHub URLs instead of relative paths.

Key Changes

  • Added README.md files to all 6 platform-specific packages:

    • @agent-rdp/darwin-arm64
    • @agent-rdp/darwin-x64
    • @agent-rdp/linux-arm64
    • @agent-rdp/linux-x64
    • @agent-rdp/win32-arm64
    • @agent-rdp/win32-x64
  • Updated package.json files for all platform packages to include README.md in the files array for distribution

  • Fixed documentation links in main README.md:

    • Changed relative link docs/AUTOMATION.md to absolute GitHub URL
    • Changed relative link docs/WEBSOCKET.md to absolute GitHub URL

Implementation Details

Each platform-specific package README includes:

  • Clear identification of the platform (e.g., "macOS ARM64 (Apple Silicon)")
  • Instructions that users should install the main agent-rdp package instead
  • Reference to the main project README on GitHub
  • MIT OR Apache-2.0 license notice

This improves the user experience when viewing these packages on npm.org, as they will now see helpful information instead of a missing README, and the main README links will work correctly regardless of where the documentation is viewed from.

https://claude.ai/code/session_01X9GrLX4PVdbbpcQ8pATH4Q

…ain 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
@thisnick thisnick changed the title Add README files to platform-specific packages and fix doc links fix: add README files to platform packages and fix relative refs in main README Jan 28, 2026
@thisnick thisnick merged commit 86390fd into main Jan 28, 2026
5 checks passed
@thisnick thisnick deleted the claude/fix-package-readme-refs-HqYkq branch January 28, 2026 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants