RobotWebTools / rclnodejs / 23331849518

86%

push

github

Update README (#1449)

Updates the project’s README content (repo README and npm package README) to reflect current supported ROS 2 distros, modernized API usage, and clearer install/docs guidance.

**Changes:**
- Refresh README messaging (supported ROS distros, reorganized documentation links, added Quick Start).
- Update README code snippets to use OO-style APIs (`new rclnodejs.Node()` + `node.spin()`).
- Improve installation/prebuilt-binary notes and clarify message generation workflow.

### Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

| File | Description |
| ---- | ----------- |
| scripts/npmjs-readme.md | Updates the npm-published README content: modernizes example code, adds docs/examples links, and documents message generation and prebuilt-binary fallback behavior. |
| README.md | Updates the repo README: supported distro note, reorganized documentation section, adds Quick Start, clarifies TypeScript typing exposure, and adds benchmark methodology disclaimer. |

Fix: #1448

1476 of 1866 branches covered (79.1%)

Branch coverage included in aggregate %.

3036 of 3382 relevant lines covered (89.77%)

452.98 hits per line