AIML-83: Improve README documentation structure #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Restructured README to highlight the one-click VS Code install button: - Moved install button from status badge section to dedicated Quick Install section - Changed badge style to for-the-badge for better visibility - Positioned Quick Install after description, before security warnings - Added clear labeling and reference to other installation options Also updated CLAUDE.md with latest build commands and architecture details. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Converted the security warning section to use GitHub's callout syntax (> [!WARNING]) for better visual prominence and consistency with modern GitHub Markdown formatting. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Updated VS Code one-click install links to use input variable pattern
(${input:...}) instead of hardcoded example credentials. This follows
MCP security best practices by prompting users for credentials during
installation rather than exposing placeholder values.
Also refined the overview statement and improved warning formatting.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
for-the-badgefor better prominenceTesting
🤖 Generated with Claude Code