docs: fix README accuracy errors - #353
Merged
Merged
Conversation
- Correct test count from 149 to 255 - Update source file line counts (filesize.js 286, helpers.js 538, constants.js 82) - Fix npm run dev description (watch mode, not live reload) - Correct npm run lint:fix to npm run fix
- Reposition as 'a popular choice' (filesize trails bytes and pretty-bytes in downloads, so 'most popular' would be inaccurate) - Fix Standards section: standard wins over base; IEC does not require base: 2 - Add a Standards comparison table (base + symbols + example) - Clarify round vs precision precedence - Move TypeScript section after Usage, keep examples verified - Tighten prose: concrete benefits over vague claims
Drop the 'popular choice' framing and the download-count claim from the intro. State what the library is and who it serves, without a number that would drift over time.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects four factual errors in README.md that were verified against the actual library, test suite, and package scripts.
Type of Change
Related Issues
N/A
Testing
wc -l src/*.js: filesize.js 286, helpers.js 538, constants.js 82npm run lintpasses (oxlint + oxfmt)npm run buildsucceeds (pre-commit hook ran rollup)Checklist
npm testpassesnpm run buildsucceedsChanges
149 tests→255 tests(actual suite count)npm run dev: "Development mode with live reload" → "Build distributions in watch mode" (it's a rollup watch, not a dev server)npm run lint:fix→npm run fix(thelint:fixscript doesn't exist)