docs: add command summaries to --help and update README usage section#178
Open
pxlman wants to merge 2 commits into
Open
docs: add command summaries to --help and update README usage section#178pxlman wants to merge 2 commits into
pxlman wants to merge 2 commits into
Conversation
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.
What does this PR do?
--helpoutput with a one‑line description for every subcommand (store,list,decode,delete-query,delete,wipe,compact,version).README.mdUsage section to be consistent with the new help text and to document all commands clearly.Why is this change useful?
Previously,
--helponly listed command names and just explained the flags not the subcommands, and the README’s “Usage” section was incomplete (e.g., missingversion,compact,decodewithout dmenu). New users had to guess or search elsewhere. These changes make the tool self‑documenting and the README a complete quick reference.Changes included
main.go– Modifiedflag.Usageto print acommands:block with short, action‑oriented descriptions.README.md– Rewrote the “Usage” section to cover every command, explain global options, and show typical examples (includingcliphist decode <id>andcliphist version).Example of new
--helpoutputtext
Testing
cliphist -helpand verified all commands appear with descriptions.readme.mdformatting renders correctly on GitHub (code blocks, bullet lists).