fluxninja / aperture

Rate limiting, caching, and request prioritization for modern workloads
https://docs.fluxninja.com
Apache License 2.0
622 stars 24 forks source link

Add Caching to introduction and readme #3031

Closed karansohi closed 9 months ago

karansohi commented 9 months ago

Description of change

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 9 months ago

Walkthrough

The recent updates introduce caching as a key feature to enhance application performance and reduce operational costs. A snippet in the README.md file details this new functionality, while the documentation reflects a shift in programming language preference from Python to TypeScript for rate-limiting examples.

Changes

File Path Change Summary
README.md Added a section on caching to improve application performance and reduce costs.
.../guides/per-user-rate-limiting.md Changed code snippet language from Python to TypeScript.
.../introduction.md Added a section emphasizing the benefits of caching.

🐇✨ In the realm of code, a change does bloom,
Caching arrives, giving slowness its doom.
From Python to TypeScript, the snippets dance,
A rabbit hops by, giving the docs a glance. 📜💨


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json`