docs: update sample code use safari and warn about in dev process (#123)

[andostronaut]

This is an automated pull request for branch docs/update-readme-usage-and-warning

Summary by CodeRabbit

• Documentation
  • Updated the development warning message to include a prominent visual alert, enhancing the notice that the project is still under active development.

[coderabbitai]

Walkthrough

The pull request modifies the README.md file by updating the warning note that indicates the project's developmental status. The original plain text warning is replaced with a formatted warning block that includes an emoji (🚧). Additionally, there is a minor typographical error introduced where "caution" is misspelled as "cautio." No other changes or functional modifications were made in this update.

Changes

File(s)	Change Summary
README.md	Updated the warning note by replacing plain text with a formatted warning block including an emoji (🚧). Minor typo: "cautio" instead of "caution".

Poem

I'm a rabbit with a cheerful hop,
Seeing warnings now with extra pop!
A 🚧 sign gleams with flair and art,
Even a typo plays its quirky part.
Hopping through updates with a joyful heart!

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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

🧹 Nitpick comments (1)

README.md (1)

16-18: Fix Typographical Error in Warning Block

The new warning block is well-formatted and clearly communicates the project's developmental status. However, there's a minor typographical error on line 17 where "cautio" should be corrected to "caution".

Apply the following diff:

-> Note: 🚧 This project is under development and is not yet ready for production use. Please use it with cautio and report any issues or bugs you encounter.
+> Note: 🚧 This project is under development and is not yet ready for production use. Please use it with caution and report any issues or bugs you encounter.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a2fbd4 and c6c5ef2.

📒 Files selected for processing (1)

• README.md (1 hunks)