Skip to content

docs: add API example requests and responses to README#46

Closed
Ai-chan-0411 wants to merge 1 commit intoO2sa:mainfrom
Ai-chan-0411:feat/readme-examples-30
Closed

docs: add API example requests and responses to README#46
Ai-chan-0411 wants to merge 1 commit intoO2sa:mainfrom
Ai-chan-0411:feat/readme-examples-30

Conversation

@Ai-chan-0411
Copy link
Copy Markdown
Contributor

Closes #30

Changes

Adds a new 📡 API Examples section to the README showing:

  • How to call GET /api/compare with multiple usernames
  • A realistic example response with repoScore, prScore, contributionScore, finalScore, topRepos, and topPullRequests
  • An error response example for when a user is not found

This helps developers quickly understand how to use the API without needing to read the source code.

/attempt 30

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 11, 2026

@aoi-dev-0411 is attempting to deploy a commit to the osama's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Copy Markdown

Thank you for the pull request! ✅

A maintainer will review this soon. Please be patient while we take a look. 🙌

@Ai-chan-0411
Copy link
Copy Markdown
Contributor Author

Closing this PR as there has been no maintainer feedback for several weeks. Thank you for the opportunity to contribute! Feel free to reopen if you would like these changes.

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.

Add example requests and responses to README

1 participant