Update README.md #630
Merged
Update README.md #630
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
ericcornelissen
added
the
documentation
Make the "Shells" section in the README shorter. This should help make the README feel shorter and by extension "easier" to read, increasing the likelihood that users read it.
Update the snippet for installing Shescape to make it copy-able as a whole. This makes it easier to use the snippet for the purposes of installing, reducing the likelihood of users being affected by typosquatting.
Move the recipes and API sections under the "Usage" section as they're about usage. This also makes the README flow more as the statement "Use shescape" is now followed by sections on how to use it (rather than a list of supported shells).
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.
Summary
Changes to the
README.mdto improve clarity.