Repository navigation
docs(readme): rewrite README for the current CLI - #213
Merged
Merged
Conversation
- Drop the removed flashduty-sdk dependency; list go-flashduty, cobra, toon-go, yaml.v3 and x/term. - Replace the hand-maintained command list (which covered about ten of the 37 groups and used outdated names) with a group overview by product area and the path-to-command rule, and point to --help and the docs for the long tail. - Link the website, CLI docs, API reference, console, blog post and related projects; use the flashduty.com and docs.flashduty.com domains. - Document whoami, update, the environment variables the CLI reads, and the Go 1.26 requirement; refresh the version example to v1.5.12. - Keep README.md and README_zh.md in step.
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
1 participant
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.
Summary
The README had drifted from the code: it listed the removed
flashduty-sdkdependency, required Go 1.24+ (go.mod is 1.26), covered about ten of the 37 command groups with some outdated names, and linked only flashcat.cloud.README.mdandREADME_zh.md(kept in step).www.flashduty.comanddocs.flashduty.comdomains.--helpand the docs carry the long tail.whoami,update, the environment variables the CLI reads, and the field-coverage test for curated commands.Verification
--helpexits 0).