docs(README): enhance badge update documentation and improve npm badge

- Updated the npm version badge in `README.md` to explicitly display the current version dynamically.
- Added a new "Badge Maintenance" section to detail the automated badge update process during build or version changes.
- Enhanced `generate-version.js` script to improve badge update logic, ensuring the npm version badge reflects `package.json` accurately.
- Strengthened maintainability and accuracy of documentation for future updates.
This commit is contained in:
David Snelling 2025-06-24 11:08:15 -07:00
parent 1210638242
commit 64d77dfb5c
2 changed files with 14 additions and 3 deletions

View file

@ -66,12 +66,12 @@ try {
// Get TypeScript version from package.json devDependencies
const typescriptVersion = packageJson.devDependencies.typescript.replace('^', '')
// Update npm badge - using a more flexible approach
// Update npm badge - using a more flexible approach with explicit version
const npmBadgeRegex = /\[\!\[npm\].*?\]\(https:\/\/www\.npmjs\.com\/package\/@soulcraft\/brainy\)/g
if (npmBadgeRegex.test(readmeContent)) {
readmeContent = readmeContent.replace(
npmBadgeRegex,
`[![npm](https://img.shields.io/npm/v/@soulcraft/brainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy)`
`[![npm](https://img.shields.io/badge/npm-v${version}-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)`
)
} else {
console.log('Warning: Could not find npm badge in README.md')