Update examples in README #77
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
inferno-chromium
approved these changes
Dec 17, 2022
|
/gcbrun |
|
@oliverchang @another-rex - fyi. i think this is how it is used in other projects as well, so approving. I don't think we need to add "$(go env GOPATH)/bin/" to every command since we assume user know how to use go. |
oliverchang
added a commit
to google/osv.dev
that referenced
this pull request
Dec 19, 2022
- Add "CLI Tools" button to home page to scroll down to the relevant section. (Similar to "Use the API"). - Remove the $GOPATH/bin prefix to match google/osv-scanner#77. - Tweak wording for OSV-Scanner section on "About" page
oliverchang
added a commit
to google/osv.dev
that referenced
this pull request
Dec 19, 2022
- Add "CLI Tools" button to home page to scroll down to the relevant section. (Similar to "Use the API"). - Remove the $GOPATH/bin prefix to match google/osv-scanner#77. - Tweak wording for OSV-Scanner section on "About" page ### CLI Tools button (desktop)  ### CLI Tools button (mobile) 
julieqiu
pushed a commit
to julieqiu/osv-scanner
that referenced
this pull request
May 2, 2023
julieqiu
pushed a commit
to julieqiu/osv-scanner
that referenced
this pull request
May 2, 2023
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.
The way it is currently written may confuse people new to Golang.
You provide instructions on how to install binary from various sources, which will essentially have the same effect - the application binary is in OS path. However, the following usage examples assume that we are working with the source code.
This PR fixes the README examples, by making assumption
osv-scanneris installed and can be directly called.