docs: simplify README for users#2
Merged
Merged
Conversation
Rewrite the README to be shorter and benefit-oriented: a one-line pitch, a 3-command quick start, a compact command table, and a small config example. Drops the verbose per-command walkthrough and edge-case prose (still covered by --help and .dev-env.example.yml).
nazarli-shabnam
added
the
documentation
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.
Rewrite the README to be shorter and benefit-oriented: a one-line pitch, a 3-command quick start, a compact command table, and a small config example. Drops the verbose per-command walkthrough and edge-case prose (still covered by --help and .dev-env.example.yml).