Skip to content

Add npm badges, installation instructions, and links to README#35

Merged
theroyalwhee0 merged 1 commit intomainfrom
34-add-npm-badges-installation
Nov 4, 2025
Merged

Add npm badges, installation instructions, and links to README#35
theroyalwhee0 merged 1 commit intomainfrom
34-add-npm-badges-installation

Conversation

@theroyalwhee0
Copy link
Owner

Summary

  • Add npm badges (version, downloads, license) to README header
  • Add Installation section with npm install command
  • Add Links section with npm, repository, and documentation links

Changes

  • Badges: npm version, npm downloads (monthly), and license badges at top of README
  • Installation: New section with npm install @theroyalwhee0/commonprops command
  • Links: Dedicated section with quick access to npm package, repository, and documentation

Test plan

  • Markdown linting passes (npm run lint:md)
  • Pre-commit hooks pass (linting, tests, docs generation)
  • Badges render correctly in GitHub
  • All links are functional

Resolves #34

Add npm package information:
- npm version badge linked to package page
- npm downloads badge (monthly)
- License badge linked to LICENSE.txt

Add Installation section:
- npm install command for @theroyalwhee0/commonprops

Add Links section:
- npm package link
- GitHub repository link
- Documentation link

Resolves #34
@theroyalwhee0 theroyalwhee0 merged commit 2de6ad6 into main Nov 4, 2025
1 check passed
@theroyalwhee0 theroyalwhee0 deleted the 34-add-npm-badges-installation branch November 4, 2025 01:24
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.

Add npm badges and installation instructions to README

1 participant