Skip to content

Conversation

@maxstevens-nl
Copy link
Member

@maxstevens-nl maxstevens-nl commented Jan 12, 2026

Summary by CodeRabbit

  • Documentation
    • Added npm badge to README.

✏️ Tip: You can customize this high-level summary in your review settings.

@maxstevens-nl maxstevens-nl changed the title Add npm version badge to README readme: add npm version badge Jan 12, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 12, 2026

Walkthrough

An npm badge line was added to README.md following the package header. This is a cosmetic documentation update with no code or functional modifications.

Changes

Cohort / File(s) Summary
Documentation badge
README.md
Added npm badge line after package header

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A badge so shiny, npm proud and bright,
In the README garden, now in plain sight!
No code was harmed in this hop of delight,
Just visual flourish—cosmetic and light! 📌

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'readme: add npm version badge' directly and clearly describes the main change: adding an npm version badge to the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@maxstevens-nl maxstevens-nl enabled auto-merge (squash) January 12, 2026 21:50
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

2-2: Nice addition! Consider making the badge clickable.

The npm version badge is correctly formatted and positioned. As an optional enhancement, you could make it clickable by linking to the npm package page.

✨ Optional enhancement to make the badge clickable
-![this package on npm](https://img.shields.io/npm/v/@loanlink-nl/libxmljs2)
+[![npm version](https://img.shields.io/npm/v/@loanlink-nl/libxmljs2)](https://www.npmjs.com/package/@loanlink-nl/libxmljs2)

This wraps the badge in a link to the npm package page and uses a more concise alt text.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24c6c40 and 411b9e8.

📒 Files selected for processing (1)
  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (macos-15-intel)

@maxstevens-nl maxstevens-nl merged commit 314f781 into main Jan 13, 2026
11 of 12 checks passed
@maxstevens-nl maxstevens-nl deleted the readme/add-npm-version-badge branch January 13, 2026 11:49
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