Move documentation from README to CLI usage text

sirwart / ripsecrets

A command-line tool to prevent committing secret keys into your source code

MIT License

800 stars 24 forks source link

Move documentation from README to CLI usage text #81

Closed lafrenierejm closed 9 months ago

lafrenierejm commented 10 months ago

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 mdsh to ensure it is kept up-to-date as the CLI's usage text changes.

lafrenierejm commented 9 months ago

@sirwart Any opinions on this PR?

sirwart commented 9 months ago

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.