chore(docs): updating readme

[madflojo]

Updates README with a little bit of more detail, but still very basic.

Summary by CodeRabbit

• Documentation
  • Renamed section in README from # protobuf-definitions to # Tarmac Protobuf Definitions.
  • Enhanced README with detailed descriptions and structure information for different protobuf files.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The changes primarily focus on renaming and restructuring the repository related to Tarmac protobuf definitions. It enhances clarity by providing a clear structure and detailed descriptions for the different message types used in the Tarmac project.

Changes

Files	Change Summary
README.md	Renamed the main section from # protobuf-definitions to # Tarmac Protobuf Definitions. Added detailed descriptions and structure information for different protobuf files.

Poem

The code, it morphs and shifts today,
To make the path more clear, hooray!
Tarmac's messages now well-defined,
With structure tidy and aligned.
A new dawn for codes, let’s cheer,
For clarity is finally here!
🌟

---

Tip

Early access features

• OpenAI gpt-4o model for reviews and chat.

Note:

• You can disable early access features from the CodeRabbit UI or by setting early_access: false in the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are always opted into early access features.

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2e6d695 and dd22d00.

Files selected for processing (1)

• README.md (1 hunks)

Additional context used

LanguageTool

README.md

[typographical] ~20-~20: Consider adding a comma here.
Context: ...Contributing Contributions are welcome please open an issue or submit a pull request ...

(PLEASE_COMMA)

Additional comments not posted (4)

README.md (4)

1-1: Update Header: Improved Clarity

The updated header "Tarmac Protobuf Definitions" provides a clearer and more specific title for the repository.

---

3-3: Introduction: Clear and Concise

The introduction sentence clearly states the purpose of the repository.

---

5-6: Usage Description: Well-Defined

The description of how the protobuf definitions are used by Tarmac SDKs or functions, and the mention of waPC for communication, is well-defined.

---

8-16: Structure Section: Informative and Organized

The structure section is informative and organized, providing a clear description of each protobuf file and its purpose.