docs: fix README.md for @github/keytar#18
Open
kushalshit27 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the project README to reference the correct scoped npm package name (@github/keytar) and expands the “Docs” section with both CommonJS and ESM usage examples.
Changes:
- Update installation instructions to
npm install @github/keytar. - Update “Supported versions” text to reference
@github/keytar. - Add both CJS (
require) and ESM (import) examples under “Docs”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kushalshit27
force-pushed
the
fix/readme
branch
from
0fe953e to
419e8e9
Compare
|
@williammartin +1 to this pull request! I am planning on adding this as a dependency in a project and noticed the readme had old information. |
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.
Context
The README.md was using the old/wrong package name keytar instead of the scoped name @github/keytar (as declared in package.json).
Changes Made
npm install keytar→npm install @github/keytar