docs: mention maintenance status in README

[sd2k]

Summary by CodeRabbit

• Documentation
  • Updated the status section of the README to clarify the project's unofficial status and maintenance expectations.
  • Enhanced formatting of the status message for better visibility.

[coderabbitai]

Walkthrough

The changes in this pull request focus on updating the README.md file to improve the clarity of the project's status and expectations for users. The status message has been revised to indicate that the project is not an official Grafana project and may experience slower maintenance. The formatting of the status message has also been changed to a block quote style for better visual distinction. Other sections of the document, including crate descriptions and development instructions, remain unchanged.

Changes

File	Change Summary
README.md	Updated status section with a clearer message about project status and maintenance; changed formatting to block quote style.

Possibly related PRs

• Specify 0.3.x in READMEs #102: The changes in this PR also involve updates to the README.md file, specifically related to versioning information, which aligns with the main PR's focus on enhancing clarity in the project's documentation.

Suggested labels

documentation

Poem

In the garden of code, where the rabbits hop,
A README now shines, with a message on top.
"Not official," it says, with a quote to display,
Guiding users gently on their coding way.
With clarity brought forth, let the project grow,
Through the thickets of change, we'll all surely flow! 🐇✨

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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

🧹 Outside diff range and nitpick comments (1)

README.md (1)

17-20: LGTM! Consider adding contribution guidelines.

The status message is clear, well-placed, and uses the correct GitHub alert syntax. It effectively sets expectations regarding maintenance and project maturity.

Consider adding a brief note about how users can contribute if they're interested in helping maintain the project. This could help address the "slower maintenance" concern. For example:

 > [!IMPORTANT]
 > Please note that this is not an official Grafana project, so
 > maintenance may be a bit slower than usual. It's still early days too
-> so expect some rough edges and changes to APIs!
+> so expect some rough edges and changes to APIs! Contributions are welcome
+> if you'd like to help improve the project.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 02ed77a and 03c3ba5.

📒 Files selected for processing (1)

• README.md (1 hunks)