docs: make library more findable #91
Open
Conversation
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
Updated project title and added a brief description.
jkowalleck
requested review from
Copilot,
jdalton,
pombredanne and
steven-esser
Member
Author
|
@jdalton please review and publish to npmjs.org |
There was a problem hiding this comment.
Pull request overview
This PR improves the discoverability of the packageurl-js library on npm by enhancing keywords and documentation. The changes address feedback that developers couldn't find this library when searching, leading them to create redundant implementations.
Changes:
- Added more specific keywords to package.json for better search visibility
- Updated README title and description to be more descriptive and search-friendly
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| package.json | Added "package-url", "packageurl", and "purl" keywords to improve npm search results |
| README.md | Enhanced the title and added a descriptive subtitle to clarify the library's purpose |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
some people expressed that they wrote new implementations for JS, solely for the reason they where unable to find the existing one when searching npmjs.com
to prevent such efforts and help this library being more visible, here is a bunch of improvements.
background regarding findability: https://cyclonedx.slack.com/archives/C06KTE3BWEB/p1768477538096019?thread_ts=1767976430.454909&cid=C06KTE3BWEB ff