Skip to content

Add installation guide to README, remove MCP section - #130

Merged
thibauult merged 1 commit into
mainfrom
feature/readme-installation-guide-fca85a
Oct 28, 2026
Merged

thibauult merged 1 commit into
mainfrom
feature/readme-installation-guide-fca85a

Conversation

@thibauult

@thibauult thibauult commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

What

Why

Installation steps were only available on the website. The MCP docs are removed because AI agents are better off using the CLI directly.

Notes

Docs only. The mcp command code is untouched.

Summary by CodeRabbit

  • Documentation
    • Added Homebrew and Docker installation instructions, including upgrade guidance and example commands.
    • Linked to online installation and setup guides.
    • The README no longer lists MCP Server tools or Claude Desktop setup instructions.

Document Homebrew and Docker installation, mirroring the online guide. Drop the MCP server docs since AI agents are better off using the CLI directly.
@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Walkthrough

The README removes the MCP Server feature details and Claude Desktop setup instructions. It adds Homebrew installation and upgrade steps, Docker commands, and links to the online installation and setup guides.

Changes: README guidance

Layer / File(s) Summary
Document installation options
README.md
The README adds Homebrew installation and upgrade commands, Docker examples, and links to online guides. It removes the MCP Server description, tool table, Claude Desktop configuration, and example prompts.

Priority: Not assessed

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Other

Possibly related PRs

Merge Risk: Low · up to 9b1d2

Docker users who later use the native CLI may need to correct configuration ownership before updating settings.

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

@thibauult
thibauult merged commit 06287dc into main Oct 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant