Skip to content

docs: fix incorrect README#6

Merged
beingmartinbmc merged 1 commit into
mainfrom
docs/fix-readme
Jun 12, 2026
Merged

docs: fix incorrect README#6
beingmartinbmc merged 1 commit into
mainfrom
docs/fix-readme

Conversation

@beingmartinbmc

Copy link
Copy Markdown
Owner

Corrects several factual errors in the README:

  • Live demo URL: anksharma11.github.iobeingmartinbmc.github.io (old link was dead).
  • Node version: "Node 20+" → "Node 22+" to match CI (node-version: '22').
  • Quick start: added the test, test:watch, and test:coverage scripts that already exist in package.json.
  • Project status: replaced the stale "Tests: none yet" with the actual Vitest suite (6 test files) + the 85% CI coverage gate.
  • Adding a visualization: fixed nonexistent useTones reference → shared useSound hook.

Docs-only change; no source code touched.

- Correct live-demo URL (anksharma11 -> beingmartinbmc GitHub Pages)
- Bump documented Node requirement to 22+ to match CI
- Add the test/test:watch/test:coverage npm scripts to Quick start
- Replace stale 'Tests: none yet' with the real Vitest suite + 85% CI coverage gate
- Fix nonexistent useTones reference -> shared useSound hook
@beingmartinbmc beingmartinbmc merged commit 5551ead into main Jun 12, 2026
1 check passed
@beingmartinbmc beingmartinbmc deleted the docs/fix-readme branch June 12, 2026 01:21
beingmartinbmc added a commit that referenced this pull request Jul 3, 2026
- Correct live-demo URL (anksharma11 -> beingmartinbmc GitHub Pages)
- Bump documented Node requirement to 22+ to match CI
- Add the test/test:watch/test:coverage npm scripts to Quick start
- Replace stale 'Tests: none yet' with the real Vitest suite + 85% CI coverage gate
- Fix nonexistent useTones reference -> shared useSound hook

Co-authored-by: beingmartinbmc <beingmartinbmc@users.noreply.github.com>
beingmartinbmc added a commit that referenced this pull request Jul 5, 2026
- Correct live-demo URL (anksharma11 -> beingmartinbmc GitHub Pages)
- Bump documented Node requirement to 22+ to match CI
- Add the test/test:watch/test:coverage npm scripts to Quick start
- Replace stale 'Tests: none yet' with the real Vitest suite + 85% CI coverage gate
- Fix nonexistent useTones reference -> shared useSound hook

Co-authored-by: beingmartinbmc <beingmartinbmc@users.noreply.github.com>
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