feat: made status page URL configurable and added description about live instance rate limits #97
Conversation
…ive instance rate limits
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Enhancement
PR Summary: This pull request introduces enhancements to the OverFast API project by making the status page URL configurable and adding a description about the live instance rate limits. Specifically, it updates the README.md to inform users about the rate limit of 30 requests per second for the live instance and suggests hosting their own instance if more is required. In the app's configuration, it adds an optional status page URL setting, allowing for flexibility in providing a status page. Additionally, the main application's description has been revised to more accurately reflect the project's capabilities and efficiency improvements.
Decision: Comment
📝 Type: 'Enhancement' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
- Unsupported files: the diff contains files that Sourcery does not currently support during reviews.
General suggestions:
- Consider adding more detailed documentation or examples on how to set up and use the new status page URL configuration for new users or contributors.
- It might be beneficial to include information on how users can monitor their usage against the rate limit or how they can request an increase if hosting their own instance.
- Review the new project description to ensure it aligns with all aspects of the project's goals and capabilities, ensuring no key features or selling points are omitted.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
No description provided.