Create initial readme#11
Merged
Merged
Conversation
TyostoKarry
commented
Mar 22, 2026
TyostoKarry
commented
Owner
- reorganize README sections for clearer flow
- document CLI modes, flags, and input rules
- add practical usage examples and sample output
- include installation, bash completion, and CI details
- reorganize README sections for clearer flow - document CLI modes, flags, and input rules - add practical usage examples and sample output - include installation, bash completion, and CI details
- update workflow badge URL to use the pull_request event - ensure README shows the correct status for the PR verification workflow
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.