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

Update README with Quickstart guide #4

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

Conversation

MrPanda1
Copy link

First, love the idea of this project, and I am just getting familiar with the existing code base so far.

Second, I figured a slightly more verbose quickstart guide may help people taking a quick look at this become more interested in it. Currently, it takes more than a minute to figure out how this API is supposed to be used, so I added to the README to help get set up quickly.

Copy link
Owner

@derivator derivator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I think this could be helpful with a few changes!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MrPanda1 MrPanda1 requested a review from derivator June 15, 2023 02:50
@MrPanda1
Copy link
Author

@derivator, All changes have been made. Let me know what you think 👍

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

Successfully merging this pull request may close these issues.

None yet

2 participants