Skip to content

docs: add the npm version and license badges - #19

Merged
SectionTN merged 1 commit into
mainfrom
docs/readme-badges
Nov 20, 2026
Merged

SectionTN merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@SectionTN

@SectionTN SectionTN commented Nov 20, 2026 •

Copy link
Copy Markdown
Owner

0.1.0 is on npm and shields has the package now, so the README gets the npm version and license badges.

Summary by CodeRabbit

  • Documentation
    • Added npm version and license badges to the README.

@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README adds npm version and license badges below its title. The badges link to the package page and repository license.

Changes: README Badges

Layer / File(s) Summary
Add npm and license badges
README.md
The README adds npm version and license badges below the title. The badges link to the package page and repository license.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: Minimal · up to f1c53

This PR adds npm version and license badges to the README. It has no runtime effect and is ready to merge.

Architecture risk: Low · up to f1c53

The change affects 1 system.

Changed systems: README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Added npm version and license badges linking to the package page and repository license; the third added line is blank.
Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs: add the npm version and license badges" matches the changeset. The README gained npm version and license badges below the title (+3/-0), and the PR objectives describe the same change…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs: add the npm version and license badges" matches the changeset. The README gained npm version and license badges below the title (+3/-0), and the PR objectives describe the same change. The title is specific, uses a conventional commit prefix, and names the primary change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 29f9eed5-7d6a-4ddd-879c-ff43dc755b14
Commits

Reviewing files that changed from the base of the PR and between 3def2d1 and f1c53c5.

Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

@SectionTN
SectionTN merged commit 93d76f3 into main Nov 20, 2026
4 checks passed
@SectionTN
SectionTN deleted the docs/readme-badges branch November 20, 2026 21:32
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.

1 participant