docs: fix README install instructions and typos - #525
Open
liuliuliu0221 wants to merge 1 commit into
Open
Conversation
- Remove sudo from npm install (unnecessary and discouraged by npm's official docs) - Fix "NodeJs" -> "Node.js" (official spelling) - Fix heading "Prerequisite" -> "Prerequisites" (section lists multiple items)
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.
Three small README fixes:
Remove
sudofromnpm install: running npm as root is unnecessary for this project and is explicitly discouraged by npm's official docs (risk of permission issues and security foot-guns). Local dependency installation does not need elevated privileges."NodeJs" -> "Node.js": official spelling per nodejs.org.
Heading "Prerequisite" -> "Prerequisites": the section lists multiple prerequisites.
Docs-only change, no code touched.