docs: update per-package READMEs for 0.2.0#94
Merged
Conversation
The npm and Packagist READMEs (packages/js, packages/php) still described the pre-0.2.0 surface. Bring them in line with the root README: - Supported formats: add TOML and CSV/TSV blocks. - New "Schema validation" section (types, constraints, each, wildcards, errorsByPath) for both languages. - API reference: add fromToml / fromCsv / fromTsv. - Exception hierarchy: add TomlParseException, CsvParseException, SchemaValidationException. - JS exports list: add the new accessors, SchemaResult, and exceptions.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
The per-package READMEs (
packages/js,packages/php) — the ones shown on npm and Packagist — still described the pre-0.2.0 surface. This brings both in line with the root README and the 0.2.0 release.Both packages:
each, wildcards,errorsByPath), with a PHP and a TS example.fromToml/fromCsv/fromTsv.TomlParseException,CsvParseException,SchemaValidationException.JS only: the
Exportslist gains the new accessors,SchemaResult, and the new exceptions.Docs-only — no source or test changes.