Commit graph

4 commits

Author SHA1 Message Date
64d77dfb5c 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.
2025-06-24 11:08:15 -07:00
ff28ffffe7 docs(CONTRIBUTING): simplify contribution steps and remove redundant test process
- Updated `README.md` and `CONTRIBUTING.md` to streamline contribution instructions.
- Removed references to running tests (`npm test`) as part of the contribution process to reduce complexity for contributors.
- Adjusted steps to focus on creating feature branches, using conventional commit messages, and submitting pull requests.
- Simplified `package.json` by removing unused devDependencies (`jest`, `@types/jest`, `ts-jest`) to reflect the updated process.
2025-06-24 10:48:24 -07:00
23e84e43ce docs(README): update badges and improve formatting for clarity
- Replaced the Cartographer badge with the npm package version badge to align with the current project focus.
- Added commented-out placeholder for the removed Cartographer badge for future reference.
- Enhanced text formatting in `README.md` to improve readability and alignment consistency.
- Updated scaling strategy section to separate lines for readability.
- Clarified deployment details for GitHub Pages and linked workflows.
2025-06-24 10:42:16 -07:00
23e50b09bf Initial commit 2025-06-24 10:16:12 -07:00