philihp / pcg / 26258206799

100%

push

github

docs: rewrite README for 2.1.0 release prep (#343)

* docs: rewrite README for 2.1.0 release prep

Document mulberry32 and sfc32 variants, state-advance helpers
(nextState/prevState/stepState/getOutput), OutputFnType and
StreamScheme options, install steps, and a 1.x→2.x migration note.
Fix the broken pcg-random.org link reference and remove the
nextState shadowing in the quick-start example.

* chore: prep 2.1.0 release

- Bump version to 2.1.0 and engines.node floor to >=18. Node 16 has
  been EOL since Sep 2023 and the active test matrix already runs on
  18/20/22/24.
- Drop the now-redundant compat job from CI; the active matrix covers
  every supported runtime end-to-end.
- Remove the broken `prepare: "husky install"` script and drop the
  unused husky / lint-staged dev dependencies. No `.husky/` was ever
  checked in and lint already runs in CI.
- Pin @types/node to ^24 to match the @tsconfig/node24 base; the
  previous ^25 floated against a major that does not exist.
- Delete dead .travis.yml and empty .coveralls.yml. CI is on GitHub
  Actions, coverage is on Coveralls via GITHUB_TOKEN — neither file
  was wired to anything.
- Tidy commented-out enum members (XSL_RR_RR, UNIQUE) and the stale
  TODO in types.ts, plus the dead 8/16/32-bit constants in
  defaults.ts. Git history preserves them if ever needed.
- Update CHANGELOG with sfc32, createPcg alias, node:test migration,
  and the engines bump.
- README: note Node 18+ as the supported floor.

* Update README.md

---------

Co-authored-by: Claude <noreply@anthropic.com>

191 of 208 branches covered (91.83%)

Branch coverage included in aggregate %.

460 of 470 relevant lines covered (97.87%)

6278.78 hits per line