docs: add a requirements section to the README - #69
Merged
Conversation
State the Node.js >= 22.12 and ESM-only requirements up front instead of only inside the migration section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AtqCsX7ptP36t5rdyaJJhM
There was a problem hiding this comment.
Pull request overview
Adds a short “Requirements” section near the top of the README so consumers see the runtime/module constraints (Node.js version + ESM-only) without needing to read the migration notes.
Changes:
- Document Node.js engine requirement (>= 22.12) in a dedicated README section.
- Document that
@dopry/pecansis ESM-only and must be imported (norequire()support).
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.
Adds a short Requirements section to the README (Node.js >= 22.12, ESM-only) so the runtime constraints are visible up front instead of only inside the "Migrating from 1.x" section.
From the 2.0 release review pass.
🤖 Generated with Claude Code
https://claude.ai/code/session_01AtqCsX7ptP36t5rdyaJJhM
Generated by Claude Code