Updated/Refactored README.md to make it more new-user friendly #62
Conversation
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
Created a few different updated to the README. Major changes include creating an overview section, addition of a short intro blurb, as well as some rewording of other sections to make them clearer. Formatting was also changed slightly to make sections more easily read/understood.
Created a few different updated to the README. Major changes include creating an overview section, addition of a short intro blurb, as well as some rewording of other sections to make them clearer. Formatting was also changed slightly to make sections more easily read/understood.
Owner
|
Not sure about the verbose twist. 🤔 Maybe I just prefer short and not overselling. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Created a few different updates to the README. Major changes include creating an overview section, addition of a short intro blurb, as well as some rewording of other sections to make them clearer/new-user friendly. Formatting was also changed slightly to make sections more easily read/understood.
Checklist
Not applicable as this is a documentation only pull request.