diff --git a/README.md b/README.md index a8c5341..e15defa 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,39 @@ pnpm run dev --- +--- + +## πŸ“‘ API Example + +The compare endpoint accepts one or more `username` query parameters. + +### Example request + +```bash +curl "api/compare?username=devimpact&username=octocat" +``` + +### Example response + +```json +{ + "success": true, + "users": [ + { + "username": "octocat", + "name": "The Octocat", + "avatarUrl": "https://avatars.githubusercontent.com/u/583231?v=4", + "repoScore": 87, + "prScore": 64, + "contributionScore": 42, + "finalScore": 73, + "topRepos": [], + "topPullRequests": [] + } + ] +} +``` + ## 🌍 Localization * Supported languages: English πŸ‡ΊπŸ‡Έ, Arabic πŸ‡ΈπŸ‡¦