Update README with VS Code installation instructions#32
Update README with VS Code installation instructions#32jamesmontemagno wants to merge 1 commit intokimsungwhee:mainfrom
Conversation
Added installation instructions for VS Code and VS Code Insiders.
WalkthroughREADME.md was updated to add VS Code installation badges, restructure the MCP server configuration by moving from a nested "mcp" wrapper to a top-level "servers" object with "apple-docs" configuration, introduce a new CLI section with command examples for adding MCP servers, and ensure proper file formatting with EOF newline. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
112-112: Use a proper heading instead of bold text for section.Line 112 uses bold emphasis (
**CLI**) but should use a markdown heading (###) to denote a proper subsection, especially since it introduces new instructional content below. This improves semantic structure and readability.~ -**CLI** ~ +### CLI ~This addresses the markdownlint MD036 violation flagged by the static analysis tools.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
112-112: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (1)
README.md (1)
92-123: VS Code installation changes look good.The addition of VS Code and VS Code Insiders installation badges, updated JSON configuration structure, and CLI commands are all properly formatted. The URLs are correct, JSON escaping is valid, and the configuration is consistent across all examples (file-based and CLI-based). The
"env": {}field is appropriate for this MCP server configuration.
Added installation instructions for VS Code and VS Code Insiders.
generated via https://mcpbadge.dev/mcp
Summary by CodeRabbit