docs: add compare API examples to README#92
Conversation
|
Someone is attempting to deploy a commit to the osama's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for the pull request! ✅ A maintainer will review this soon. Please be patient while we take a look. 🙌 |
O2sa
left a comment
O2sa
left a comment
There was a problem hiding this comment.
It will be better if put the full response and consider to use the default usernames of the ui.
| ### Example request | ||
|
|
||
| ```bash | ||
| curl "http://localhost:3000/api/compare?username=octocat&username=torvalds" |
There was a problem hiding this comment.
Change the domain to be a placeholder instead of http://localhost or it would be better if you remove it at all.
| curl "http://localhost:3000/api/compare?username=octocat&username=torvalds" | |
| GET "api/compare?username=octocat&username=torvalds" |
O2sa
left a comment
O2sa
left a comment
There was a problem hiding this comment.
It will be better if put the full response and consider to use the default usernames of the ui.
|
Updated. I switched the compare example to a placeholder API path and used default-style usernames in the sample request. |
|
✨ Thank you, @nightcityblade! Another great contribution merged! 🚀 You've been a fantastic contributor! We truly appreciate your continued support. |
2 participants
Fixes #30
Additionally, at the time of submission of this PR: