updated readme

[abdullah-trackier]

🛡️ Security Checklist

Review and check all that apply before requesting a review.

• Secrets: I have verified that no API keys, passwords, or certificates are hardcoded.
• Dependencies: I have checked for known vulnerabilities in any new libraries added.
• Data Handling: Sensitive data (PII) is encrypted or masked in logs.
• Input Validation: All user-provided input is sanitized to prevent SQLi or XSS.
• Permissions: New endpoints or features follow the Principle of Least Privilege.

⚙️ Backend & Performance

• Database: I have checked for N+1 query issues and verified index usage.
• Migrations: Database migrations are reversible (where applicable) and tested.
• Error Handling: Errors are caught and returned with appropriate HTTP status codes.
• Scalability: Large datasets are handled via pagination, not loaded entirely into memory.
• Async: Long-running tasks are moved to background workers (if applicable).

🧪 Testing & Quality

• Unit Tests: Added/updated tests for the core logic.
• Integration: Verified that API contracts haven't broken for downstream services.
• Observability: Added logs or metrics to track the success/failure of this feature.
• Documentation: Updated Swagger/OpenAPI specs or internal READMEs.

✍️ Sign-off

• I confirm that I have performed a self-review of this code from a security perspective.

Reviewer Sign-off: (To be completed by the reviewer)

• Security standards verified.

[coderabbitai]

Warning

Rate limit exceeded

@abdullah-trackier has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch readmeupdate

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}