imp(docs): Add readme

[MalteHerrmann]

This PR adds the readme for the evmOS repository.

Summary by CodeRabbit

• New Features
  • Introduced a comprehensive README that details evmOS features, benefits, and integration processes.
  • Added a roadmap outlining future developments and partnership opportunities for evmOS.
• Improvements
  • Enhanced changelog to include a reference to the new README, indicating ongoing improvements in documentation and user guidance.

[coderabbitai]

Walkthrough

This update enhances the project by introducing a comprehensive README file for evmOS. It details features, integration processes, configurations, and a roadmap, significantly improving documentation and user guidance. The changelog entry reflects this addition and emphasizes the project's commitment to clarity and support for its users.

Changes

File	Change Summary
CHANGELOG.md	Added an entry noting the addition of a README file under "Improvements," linked to pull request #38, highlighting enhanced documentation.
README.md	Expanded the README with detailed explanations of evmOS features, benefits, integration processes, configurations, roadmap, and partnership opportunities.

Poem

In the meadow, bright and wide,
A README blooms, our trusty guide.
With features shared and paths to trace,
evmOS shines in every space.
Let's hop along, explore and play,
Knowledge grows with each new day! 🐇✨

---

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

[0xstepit]

Very cool description @MalteHerrmann! Could you just please lint the markdown to have a consistent style? Like max columns in a row, blank line between UL or OL?

[coderabbitai]

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b051d35 and 1af4098.

Files ignored due to path filters (1)

• evmOS_repo_header.png is excluded by !**/*.png

Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• CHANGELOG.md

Additional context used

LanguageTool

README.md

[style] ~106-~106: Try using a synonym here to strengthen your writing.
Context: ...ls (Opcodes)* Any evmOS partner is given the opportunity to customize bits of th...

(GIVE_PROVIDE)

---

[uncategorized] ~117-~117: Possible missing comma found.
Context: ...andling of the transactions can diverge in e.g. result or cost. We like to coin t...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[style] ~122-~122: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... valid smart contract from Ethereum but is able to implement new features that are not (ye...

(BE_ABLE_TO)

---

[uncategorized] ~140-~140: A comma is probably missing here.
Context: ...ckchains - integrate with Rollchain Of course we are always open to collaborate with ...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)

Markdownlint

README.md

1-1: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (3)

README.md (3)

3-14: Clear and informative introduction.

The section effectively outlines the benefits of evmOS and is well-structured.

---

16-25: Comprehensive integration details.

The section provides detailed information on integrating evmOS. Ensure title style consistency as previously suggested.

---

143-159: Informative partnership section.

The section is well-structured and provides clear information on partnership opportunities.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1af4098 and 5c977b6.

Files selected for processing (1)

• README.md (1 hunks)

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

• README.md