Improve readme.md
#999
Merged
Improve readme.md
#999
Conversation
This file contains 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
ehmicky
force-pushed
the
improve-readme
branch
3 times, most recently
from
92dc9f1
to
3708211
Compare
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.
This PR aims at improving the
readme.md.The examples and feature sections have been improved incrementally for a few years. After adding so many features, they might now benefit from some makeup. This PR tries to focus the
readme.mdon the important and distinctive features Execa offers.It also adds a couple of sentences at the beginning explaining Execa's main purpose.
Moreover, it improves a little the examples related to the verbose mode, including adding a screenshot of the output with colors.
Finally, it reworks the examples in the
readme.mdto make them shorter. It focuses them on giving a general idea of what the feature is, as opposed to showing its precise syntax and details (which the documentation can do instead).