Polished your README! #1660
Open
Polished your README! #1660
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
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.
Hey Shopify, thought your README could use some help!
I added a getting started section and formatted most of the readme so that it's easier on the eyes. I also added a quick video demonstrating the new getting started section. It's hosted on replayable.io, a company that's sponsoring my contributions.
If you accept my PR. We'll have our bot check your readme everyday for changes and notify us in case we need to update the instructions (or the video I've added). We respond to changes real quick (usually within a day or two).
Let me know what you think or if you have any questions.
I believe these changes will help your users especially newbies who might be looking to use your library.