docs: simplify readme

[amimart]

I propose some enhancements in the README.md by removing documentation related to the usage with the docker image as it is outdated and already covered elsewhere.

To enhance developper experience I propose to enhance the contributing section mentioning how to run a local network.

Summary by CodeRabbit

• Documentation
  • Updated the README.md to streamline installation and usage instructions for the axoned project.
  • Consolidated Docker instructions into two main categories: "From release" and "From source."
  • Simplified Docker installation process with a single curl command for ease of use.
  • Revised Docker usage section to include a single command for running the container with help options, enhancing user experience.

[coderabbitai]

Warning

Rate limit exceeded

@amimart has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 45 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 2a3a014 and caaca26.

Walkthrough

The recent changes to the README.md file streamline the installation and usage instructions for the axoned project. The documentation now emphasizes simplicity by consolidating Docker commands and minimizing detailed subsections, making it easier for users to get started quickly with the project. This update enhances clarity and focuses on essential commands, improving the overall user experience.

Changes

Files	Change Summary
README.md	Consolidated installation instructions into "From release" and "From source"; simplified Docker commands to a single curl execution; removed detailed commands for various operations to enhance clarity.

Poem

In a world of code, so bright and new,
A rabbit hops forth, with joy to pursue.
With simpler paths and clearer ways,
We'll code and create through sunny days!
So let’s celebrate, with a joyful cheer,
For every change brings the project near! 🐇✨

---

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

@@            Coverage Diff             @@
##             main     #715      +/-   ##
==========================================
+ Coverage   54.42%   54.49%   +0.06%     
==========================================
  Files          73       73              
  Lines        2901     2905       +4     
==========================================
+ Hits         1579     1583       +4     
  Misses       1228     1228              
  Partials       94       94              

see 1 file with indirect coverage changes

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 67e3e71 and 2a3a014.

Files selected for processing (1)

• README.md (1 hunks)

Additional comments not posted (5)

README.md (5)

62-79: Simplified installation instructions look good!

The new installation instructions are clear and concise. The methods "From release", "From source", and "Using docker" are well-documented.

---

70-73: Building from source instructions look good!

The make install command is appropriate for building from source and is correctly documented.

---

76-79: Docker usage instructions look good!

The docker run command is appropriate and correctly documented.

---

62-79: Overall structure of the "Install" section is clear and concise.

The simplified "Install" section enhances clarity and ease of use, focusing on essential commands.

---

64-67: Verify the safety of the curl command.

Using curl to download and execute a script can be risky. Ensure the script is from a trusted source and consider adding a checksum verification step.

[ccamel]

👍