doc: update readme

[ren0503]

No description provided.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Summary by CodeRabbit

• Documentation
  • Updated README title, layout, and branding with a centered header, logo, and badges.
  • Added Overview and Features sections to clarify purpose and capabilities.
  • Introduced a Quick Start with environment-based and YAML-based configuration examples.
  • Documented integration patterns for registering global configuration and injecting config in modules.
  • Retained and reorganized the Install section for better flow.
  • Added Contributing guidelines and Support information.
  • Overall, expanded from a minimal readme to comprehensive documentation with practical examples.

Walkthrough

The README.md is rewritten: updated title, centered header with logo and badges, added Overview, Features, Quick Start examples for env and YAML configs, and “Tinh Tinh Module Integration” with registration and injection examples. Install remains, with added Contributing and Support sections. No code changes.

Changes

Cohort / File(s)	Summary
Documentation README.md	Reworked README: new title, centered header with badges and logo, added Overview, Features, Quick Start (env and YAML examples), module integration (ForRoot, Inject) examples, and Contributing/Support; retained Install section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibbled the docs with a gentle hop,
Polished the title, perched badges on top.
A dash of examples, YAML and env,
Injecting config—my favorite trend.
With ears up high, I stamp and grin:
“Quick Start is ready—come dive in!” 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 607d9ba and 8bd7f8f.

📒 Files selected for processing (1)

• README.md (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/ren/update-readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.