Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polished your README! #1660

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

NuclearMachine
Copy link

@NuclearMachine NuclearMachine commented Dec 17, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant