fluxninja / aperture

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

Update each SDK readme with code examples #3172

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 README.md files for the SDKs of FluxNinja Aperture across various programming languages—C#, Go, Java, JavaScript, and Python—have been updated. These updates include new usage sections with code examples, revised functionality descriptions for clearer integration guidance, and enhanced flow functionality demonstrations. These changes aim to facilitate developers in integrating their .NET, Go, Java, JavaScript, and Python applications with FluxNinja Aperture more effectively.

Changes

Files Change Summaries
sdks/aperture-csharp/README.md Updated with a new "Usage" section including examples for installation, creating an Aperture client, and flow usage.
sdks/aperture-go/README.md Revised functionality description to emphasize integration with FluxNinja Aperture and added installation instructions.
sdks/aperture-java/README.md Added usage instructions including creating an Aperture client and utilizing flow functionality.
sdks/aperture-js/README.md Rephrased functionality description, updated documentation link, and expanded usage section with examples.
sdks/aperture-py/README.md Improved integration with FluxNinja Aperture, including rephrasing in the introductory comments, addition of usage instructions, and a new example demonstrating the flow functionality.

🐰✨
In the world of code where ninjas reign,
Across the lands of C#, Go, and Python's domain,
Updates bloom like flowers in spring's embrace,
Guiding devs through Aperture's maze with grace.
🌼🐇✨


Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.