docs: Add modern README.md

[philprime]

Summary

Complete redesign of the README following 2025 documentation best practices, inspired by the GitHub MCP Server README.

Key Improvements

📝 Enhanced Structure

• Compelling Introduction: Clear value proposition and use cases at the top
• Professional Layout: Organized sections with tables and side-by-side comparisons
• Better Hierarchy: Logical flow from installation → configuration → usage → development

🚀 Installation Section

Expanded from single option to three comprehensive methods:

• ✅ Pre-built binary (recommended) with platform-specific instructions
• ✅ Docker with pull and run examples
• ✅ Build from source with detailed steps

🔧 Configuration Guides

Added detailed setup instructions for 5 major platforms:

• VS Code with GitHub Copilot (1.101+)
• Claude Desktop (macOS/Windows/Linux paths)
• Cursor IDE
• Windsurf IDE
• Generic MCP clients

Each includes:

• Prerequisites
• Configuration files with exact paths
• Side-by-side binary vs Docker examples
• Troubleshooting tips

📚 Documentation Improvements

Tools Documentation

• Both get_action_parameters and get_readme fully documented
• Parameter tables for clarity
• Real example queries users can ask
• Complete response structure examples

Example Workflows

• Discovering action parameters
• Building workflows with AI assistance
• Comparing action versions
• Exploring new actions

Development Section

• Setup instructions
• Testing commands
• Manual MCP testing (with accurate explanation of server behavior)
• Project structure
• Contributing guidelines

🎯 User Experience

• Clear troubleshooting sections for each platform
• Realistic expectations (MCP servers don't output to console)
• Natural language query examples
• Professional polish with security considerations

📊 Content Statistics

• Before: 224 lines, basic documentation
• After: 613 lines, comprehensive guide
• Additions: 468 insertions, 79 deletions

Why This Matters

A well-documented project is critical for user adoption. This README now:

• ✅ Matches industry standards (GitHub's official MCP server style)
• ✅ Supports multiple platforms and installation methods
• ✅ Provides clear troubleshooting guidance
• ✅ Shows real-world usage examples
• ✅ Makes it easy for new users to get started

Preview

The new README includes:

• Modern markdown formatting with tables
• Clear section hierarchy
• Professional tone
• Accurate technical information
• Links to related projects

Related PR

This PR complements #5 which adds the get_readme tool and code refactoring.