Reorganize badges on README#1483
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s README presentation by reorganizing the top-level badges/CI status section and lightly reformatting the benchmarks section to improve readability.
Changes:
- Split the single-line badge block into multiple lines and add a GitHub stars badge.
- Replace the ROS distro/CI status table with a ROS 2 “supported distros” badge plus per-platform workflow badges.
- Reformat the Performance Benchmarks table for numeric alignment and move the methodology note after the table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](https://www.npmjs.com/package/rclnodejs) | ||
| [](https://www.npmjs.com/package/rclnodejs) | ||
| [](https://github.com/RobotWebTools/rclnodejs/stargazers) | ||
| [](https://coveralls.io/github/RobotWebTools/rclnodejs?branch=develop) | ||
| [](https://nodejs.org/en/download/releases/) | ||
| [](https://www.npmjs.com/package/rclnodejs) |
There was a problem hiding this comment.
The PR title says this is a reorganization of badges, but this change also drops the GitHub license badge and the Prettier/code-style badge (previously present in the single-line badge row). If the intent is only to reorder, consider re-adding those badges or clarify that removing them is desired.
README.md
Outdated
| | **ROS 2 Distro** | **CI Status** | | ||
| | :--------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |
There was a problem hiding this comment.
The Markdown table header/separator uses extremely long runs of spaces and dashes, which makes the README harder to edit and increases diff noise without affecting rendering. Consider simplifying the table header and alignment row to a minimal form (e.g., standard | --- | --- |) while keeping the same displayed content.
| | **ROS 2 Distro** | **CI Status** | | |
| | :--------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | |
| | **ROS 2 Distro** | **CI Status** | | |
| | :---: | :---: | |
Changes
README.md
Badges (lines 3–8):
CI status table (lines 10–12):
ROS Distro*→ROS 2 Distro,Status→CI Status<br>for proportional scaling| :---: | :---: |Intro (line 14):
Performance table (line 246):
.prettierignore (new)
README.mdandscripts/npmjs-readme.mdfrom Prettier auto-formatting to prevent table separator padding from being re-expanded on commitFix: #1482