feat: updated installation guide in readme Implements #1360

[Malayt04]

In this update

• Updated the installation guide on the readme section for better understanding

Summary by CodeRabbit

• Documentation
  • Completely revised the README for improved clarity and structure.
  • Updated setup instructions with a streamlined, step-by-step guide.
  • Enhanced guidance for configuring external services and environment variables.
  • Added recommendations for Windows users.
  • Updated sponsor logos and improved visual presentation.
  • Included a link to the translation guide in the contribution section.
  • Made minor text and formatting improvements throughout.

[coderabbitai[bot]]

Walkthrough

The README.md file was thoroughly rewritten to enhance clarity and user guidance for local setup of the Zero project. The update restructures setup instructions, revises the logo and tagline, adds detailed environment variable explanations, and improves sections for external service configuration, contribution, and sponsor display.

Changes

File(s)	Summary of Changes
README.md	Complete rewrite for clarity and structure; updated logo style, tagline, setup instructions, env variable table, external service setup, contribution guide, and sponsor display.

Possibly related PRs

• Mail-0/Zero#429: Also modifies README.md setup instructions, but with a single command addition rather than a full rewrite.
• Mail-0/Zero#438: Adds a translation guide link to README.md, overlapping with the contribution section changes in this PR.
• Mail-0/Zero#428: Updates README.md to fix a directory name typo within setup instructions, related by file and purpose.

Poem

Hopping through docs with nimble delight,
I tidied the README all through the night.
With logos and guides and setup anew,
Now Zero’s instructions are clear for you!
🥕✨
Just follow each step and soon you shall see,
A project well-started—by rabbit and thee!

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

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

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[rohhann12]

@Malayt04 you can also add about twilio, dont want to make another pr just for this, if you can update

[Malayt04]

@rohhann12 Yeah makes sense. Will modify it

[Malayt04]

@aialok only the env vars that are necessary for running the project locally are mentioned in the table. Will surely write about the installation without docker. Thanks for the feedback.

[MrgSub]

This PR removes a lot of good parts of the current README