fix: add language-specific README files for npm and crates.io#20
fix: add language-specific README files for npm and crates.io#20
Conversation
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #19
Copy README.md from repository root to js/ directory before npm publish so the package documentation is visible on npmjs.com. This fixes the issue where the npm package was missing documentation because the package is published from the js/ subdirectory. Fixes #19 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
|
As we now have two saparate language versions, I think we should have README.md files in both JS and Rust forlders, and have common README.md that is not specific to any of these languages. So we should have common README.md, and language specific ones that will go directly to their respective package managers. I don't like the idea of just coping README.md file. |
|
🤖 AI Work Session Started Starting automated work session at 2026-01-10T13:09:39.412Z The PR has been converted to draft mode while work is in progress. This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback. |
- Create js/README.md with JavaScript/npm-specific documentation - Create rust/README.md with Rust/Cargo-specific documentation - Update root README.md to be language-agnostic with links to implementations - Remove README copy step from CI workflow (no longer needed) - Remove js/README.md from .gitignore (now tracked in git) This approach provides proper documentation for each package manager: - npm package gets js/README.md directly from the repository - crates.io can use rust/README.md - Root README provides overview linking to both implementations 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Solution UpdatedBased on the feedback about having separate README files for each language implementation, the solution has been revised: Changes Made
Verification
The PR is now ready for review. |
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
Summary
js/README.md: JavaScript/npm-specific documentation with installation and API usagerust/README.md: Rust/Cargo-specific documentationREADME.md: Common overview linking to both implementationsjs/README.mdfrom.gitignore(now tracked in git)Approach (per feedback)
Instead of copying the root README during npm publish, we now maintain separate documentation:
This approach:
Test plan
npm pack --dry-runthat README.md (8.8kB) is included in tarballFixes #19
🤖 Generated with Claude Code