feat:Update README with installation instructions and usage examples

[HavenDV]

Summary by CodeRabbit

• New Features
  • Enhanced API documentation by specifying the parameters field type as an object, improving clarity for clients interacting with the API.

[coderabbitai]

Walkthrough

The change involves an update to the OpenAPI specification in the openapi.yaml file. It introduces a new property under the parameters section, specifying its type as object. This modification clarifies the expected structure of the parameters, indicating that they are to be treated as an object, which may include nested properties.

Changes

File	Change Summary
src/libs/DeepInfra/openapi.yaml	Added type: object to parameters in the components section

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    Client->>API: Send request with parameters
    API-->>Client: Validate parameters
    API-->>Client: Process request
    Client-->>API: Receive response

Loading

Poem

In the meadow, changes bloom,
Parameters now find more room.
An object they proudly declare,
Nestled properties everywhere!
Hopping with joy, we sing and play,
A clearer path for us today! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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 <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 589e288 and 52ac33e.

Files selected for processing (1)

• src/libs/DeepInfra/openapi.yaml (1 hunks)

Additional comments not posted (1)

src/libs/DeepInfra/openapi.yaml (1)

2861-2861: Clarification of parameter type approved.

The addition of type: object to the parameters section enhances the clarity and usability of the API by explicitly defining the expected type. This change is consistent with best practices for API documentation.