docs: improve README.md #11
Merged
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
|
Hey @MichaelCurrin! Thanks for the PR! Could you please add your name under the 'Contributors' section? I will merge the PR after that is done |
|
Done! I also fixed a mistake I made. And also improved Contributing section. The features and issues sections made sense to be combined under a heading. And the bit about PRs was not clear. The set origin bit is not a needed and is confusing if you don't even have a clone yet. |
|
Thanks for your contribution, Michael! |
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.
I covered HTML to Markdown mostly. And indented code neatly in bullet points.
Converted a bullet list into a numbered list.
I added a link to the big GIF goes to the website when clicked.
Fixed some typos.
Made all the H1s into H2s except for the main heading. It is bad practice to have more than one H1 on a page. Linters / accessibility checkers will complain.