Update readme usage section #171
Merged
Conversation
This file contains 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
Clarify the options between scanning a directory, specifiying SBOM, and specifying lockfiles.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
G-Rath
reviewed
Jan 27, 2023
Co-authored-by: Gareth Jones <[email protected]>
G-Rath
reviewed
Jan 27, 2023
G-Rath
reviewed
Jan 27, 2023
G-Rath
reviewed
Jan 27, 2023
Co-authored-by: Gareth Jones <[email protected]>
Co-authored-by: Gareth Jones <[email protected]>
|
@olivekl wants to review next week. She is also checking on the CLA issue. |
another-rex
approved these changes
Feb 2, 2023
olivekl
reviewed
Feb 2, 2023
Co-authored-by: Rex P <[email protected]>
Co-authored-by: Rex P <[email protected]>
hayleycd
commented
Feb 2, 2023
hayleycd
commented
Feb 2, 2023
oliverchang
reviewed
Feb 2, 2023
README.md
Outdated
| @@ -83,46 +83,43 @@ All releases on the same Major version will be guaranteed to have backward compa | |||
|
|
|||
| ## Usage | |||
|
|
|||
| OSV-Scanner collects a list of dependencies and versions that are used in your project, before matching this list against the OSV database via the [OSV.dev API](https://osv.dev#use-the-api). To build the list of dependencies, you can point OSV-Scanner at your project directory, or manually pass in the path to individual manifest files. | |||
| OSV-scanner parses lockfiles, SBOMs, and git directories to determine your project's open source dependencies. These dependencies are matched against the OSV database via the [OSV.dev API](https://osv.dev#use-the-api) and known vulnerabilities are returned to you in the output. | |||
There was a problem hiding this comment.
We've stylized this tool as "OSV-Scanner" in many places. Any particular reason to change this to "OSV-scanner" with the lowercasing?
There was a problem hiding this comment.
Nope. That is me learning the ropes.
hayleycd
commented
Feb 2, 2023
oliverchang
approved these changes
Feb 2, 2023
hayleycd
added a commit
that referenced
this pull request
Mar 9, 2023
These are some small changes to the usage section of the README, based on conversations with @olivekl. The goal was to clarify the different options available to the user.
julieqiu
pushed a commit
to julieqiu/osv-scanner
that referenced
this pull request
May 2, 2023
These are some small changes to the usage section of the README, based on conversations with @olivekl. The goal was to clarify the different options available to the user.
julieqiu
pushed a commit
to julieqiu/osv-scanner
that referenced
this pull request
May 2, 2023
These are some small changes to the usage section of the README, based on conversations with @olivekl. The goal was to clarify the different options available to the user.
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.
These are some small changes to the usage section of the README, based on conversations with @olivekl.
The goal was to clarify the different options available to the user.