Added a link to the list of available options and env parameters#67
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a direct link in the README to the webspicy binary for quickly viewing available command-line options.
- Added a hyperlink to
./bin/webspicyunder the help section - Provides an alternative to running
webspicy --helpwhen the tool isn’t installed locally
Comments suppressed due to low confidence (2)
README.md:52
- [nitpick] For improved readability, consider adding a comma after 'Alternatively':
"Alternatively, you can see the available options here."
Alternatively you can see the available options [here](./bin/webspicy).
README.md:52
- The PR description mentions both available options and environment parameters, but the link text only refers to options. Consider updating the text to clarify that environment parameters are also documented or provide a separate link.
Alternatively you can see the available options [here](./bin/webspicy).
It's the easiest way to find them, when you don't have webspicy installed you don't remember how to run it with `-h`.
002a79f to
93fe3b3
Compare
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.
It's the easiest way to find them, when you don't have webspicy installed you don't remember how to run it with
-h.