docs: polish README and relax engines to Node 20 - #8
Merged
Conversation
Add badges and an honest vs WHATWG URL table. engines >=20 is the lowest line Vitest 4 can prove; stay 0.x until URI Template. No parser or API changes. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
🟢 Approval recommended
The documentation, package metadata, CI matrix, and changeset are consistent and introduce no unresolved correctness issues.
Pull request overview
Polishes project documentation and expands supported Node.js versions to Node 20.
Changes:
- Adds badges, attribution, related-project links, and usage guidance.
- Moves development attribution to the contributing guide.
- Adds Node 20 support to package metadata, CI, and release notes.
File summaries
| File | Description |
|---|---|
| README.md | Improves introductory documentation and guidance. |
| CONTRIBUTING.md | Adds development attribution. |
| package.json | Lowers the Node.js minimum to 20. |
| package-lock.json | Synchronizes package engine metadata. |
| .github/workflows/ci.yml | Tests Node.js 20, 22, and 24. |
| .changeset/node20-and-docs.md | Records the minor release changes. |
Review details
- Files reviewed: 5/6 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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
temporal-parser.URLunless you need a lossless AST / host-path / no-scheme parse” table.engines.node>=22→>=20. CI matrix adds20.x. Stays 0.x (URI Template still open). No parser or API changes.chore: version packages; merging that publishes to npm.Test plan
npm test— 166 passed locallynpm run build— ESM + CJS + typesMade with Cursor