Move documentation from README to CLI usage text #81
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
lafrenierejm
changed the title
lafrenierejm
changed the title
|
@sirwart Any opinions on this PR? |
|
Hi Joseph, sorry for the delay. Unfortunately I don't think this is a good change for ripsecrets at the moment. Right now ripsecrets is not updated very often, so I don't think it's worth making the project more complicated in order to keep the documentation up-to-date. I'm really focused on changes that fix bugs experienced by users of the tool. Thanks for updating the deps and fixing the Clippy errors in the other PR, that's very much appreciated. |
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 help information that had previously been present only in the repo's README is now included in the CLI's usage text. Since that documentation is now available at runtime, the README has been updated to use
mdshto ensure it is kept up-to-date as the CLI's usage text changes.