Skip to content

Update outdated parts of README - #338

Merged
keichi merged 1 commit into
masterfrom
update-readme
Nov 11, 2026
Merged

keichi merged 1 commit into
masterfrom
update-readme

Conversation

@keichi

@keichi keichi commented Nov 11, 2026

Copy link
Copy Markdown
Owner

Updates outdated or incorrect parts of the README.

  • Remove the note that 64-bit integer methods require Node v12 or later. The package now requires Node >= 22.12.
  • array(): list all supported element types: 64-bit integers, float/double, and aliases defined with namely().
  • array(): document the key option, which was previously undocumented, and add an example.
  • Fix the formatter example to use type: "uint8" instead of type: uint8.
  • Fix a typo: "maginc" → "magic".
  • wrapped() example: use an ESM import instead of require, to match the rest of the README.
  • Contributing section: mention npm run format:fix and npm run lint.

- Drop the Node v12 note for 64-bit integers
- List all supported element types for array()
- Document the key option of array()
- Fix formatter example (type: "uint8") and a typo
- Use ESM import in the wrapped() example
- Mention format and lint in the Contributing section
@keichi
keichi merged commit 8a026d9 into master Nov 11, 2026
6 checks passed
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