docs: update Node.js version requirement in README to match package.json#973
Open
Vikash9546 wants to merge 1 commit into
Open
docs: update Node.js version requirement in README to match package.json#973Vikash9546 wants to merge 1 commit into
Vikash9546 wants to merge 1 commit into
Conversation
- Update Node.js minimum version requirement in README from Node 4 to Node 8 to match `engines.node` in `package.json`. - Fix minor grammar issues regarding operating system compatibility.
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 of the change
This PR updates the README to accurately reflect the Node.js
>=8requirement established in thepackage.jsonengines field, updating it from the previously stated Node 4 requirement. I also fixed a minor grammatical issue describing the operating system support.Why the change is needed
To avoid confusion for new users trying to run the framework on older node versions and failing, the documentation should be kept in sync with the package dependency requirements.
Implementation details
README.mdfile.How it was tested
The textlint suite was executed using
npm run textlintto ensure the markdown is compliant. Additionally, manually confirmed that theengines.nodewithinpackage.jsoncorrectly mandates Node 8 or higher.Any breaking changes
No testing/runtime changes. Purely an update to human-readable markdown.