docs: fix install command for local dev dependency#3
Merged
Conversation
Fixes wess#2. `bun add -D rove` resolves to an unrelated npm package (rove). Since this project is distributed via GitHub only, the local dev dependency command must reference the repo directly: `bun add -D github:wess/rove`.
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
2 participants
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.
Fixes #2.
The README's Installation section lists the local dev dependency command as:
A bare
bun add -D roveresolvesroveagainst the npm registry, which pulls an unrelated package (https://www.npmjs.com/package/rove) rather than this project. Since Rove is distributed via GitHub only (not published to npm), the command must reference the repository directly:This PR changes only that single command line; the rest of the README is untouched.