docs: polish README and relax engines to Node 20 - #21
Merged
Conversation
Add badges, playground, and an honest vs Temporal/luxon table so the package is listable. engines >=20 is the lowest line Vitest 4 can prove; Node 18 is EOL and is not claimed. No parser or API changes. Co-authored-by: Cursor <cursoragent@cursor.com>
🦋 Changeset detectedLatest commit: 4d6f0e5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
🟢 Approval recommended
The documentation, engine metadata, CI matrix, and changeset are consistent and contain no unresolved correctness issues.
Pull request overview
Updates documentation and expands supported Node.js compatibility without parser or API changes.
Changes:
- Adds README badges, project guidance, credits, and related links.
- Lowers the Node.js requirement to 20 and adds Node 20 CI coverage.
- Adds a patch changeset and relocates the LLM development note.
File summaries
| File | Description |
|---|---|
README.md |
Improves project overview and usage guidance. |
package.json |
Lowers the Node.js engine requirement. |
package-lock.json |
Synchronizes the engine metadata. |
CONTRIBUTING.md |
Adds the development-assistance note. |
.github/workflows/ci.yml |
Adds Node 20 to the test matrix. |
.changeset/node20-and-docs.md |
Records the patch 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
uri-parser.engines.node>=22→>=20(Vitest 4 cannot run on 18; 18 is EOL). CI matrix adds20.x. No parser or API changes.chore: version packages; merging that publishes to npm.Test plan
npm test— 461 passed locallynpm run build— ESM + CJS + typesMade with Cursor