Skip to content

docs: improve readme - #26

Merged
mvantellingen merged 1 commit into
mainfrom
docs/readme
Oct 26, 2026
Merged

mvantellingen merged 1 commit into
mainfrom
docs/readme

Conversation

@mvantellingen

Copy link
Copy Markdown
Member

Rewrites the README: description, installation, requirements (Node >= 22, ESM, no peer deps), usage examples checked against src/index.ts, field/load option reference, development scripts, changesets release flow and license.

Also fixes the old example, whose validator returned a boolean; validators have to throw to reject a value.

@changeset-bot

changeset-bot Bot commented Oct 26, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 651619c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mvantellingen
mvantellingen merged commit dbcafc0 into main Oct 26, 2026
6 checks passed
@mvantellingen
mvantellingen deleted the docs/readme branch October 26, 2026 14:14
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