doc: add readme

[tuxcanfly]

Overview

This PR adds a README.

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

Summary by CodeRabbit

• Documentation
  • Updated guide for the Data Availability interface used in modular blockchains.
  • Added instructions for generating protobuf files, linting, and testing.
  • Included contribution guidelines.

[coderabbitai]

Walkthrough

The go-da file introduces a generic Data Availability interface for modular blockchains. It defines methods for retrieving, committing, and validating data, and provides helpful commands for generating protobuf files, linting, testing, and contributing to the project.

Changes

File(s)	Change Summary
README.md	Introduced a generic Data Availability interface and utility commands for development support.

🐇✨
To the chain, a new link adds,
Data flows, no longer in drags.
With code we weave nets,
Catching bytes in our steps. 🌐💾

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 82f5296 and 06756f8.

Files selected for processing (1)

• README.md (1 hunks)

Additional comments: 6

README.md (6)

• 1-8: The introduction provides a clear overview of the project's purpose.
• 18-26: The DA Interface section clearly lists the methods and their parameters and return types.
• 30-31: The Implementations section correctly references an external repository for an implementation example.
• 33-47: The Helpful commands section provides clear instructions for generating protobuf files, linting, and running tests.
• 49-62: The Contributing section is welcoming and provides useful links for potential contributors.
• 64-66: The Code of Conduct section appropriately links to the community's code of conduct.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (82f5296) 79.31% compared to head (9e0e493) 79.31%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   79.31%   79.31%           
=======================================
  Files           3        3           
  Lines         174      174           
=======================================
  Hits          138      138           
  Misses         28       28           
  Partials        8        8           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 06756f8 and b574299.

Files selected for processing (1)

• README.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• README.md

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between b574299 and dfb433c.

Files selected for processing (1)

• README.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• README.md

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between dfb433c and 9e0e493.

Files selected for processing (1)

• README.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• README.md