Skip to content

Conversation

MAVRICK-1
Copy link
Contributor

@MAVRICK-1 MAVRICK-1 commented Sep 18, 2025

This pull request updates the README.md to improve installation instructions and highlight platform compatibility for the MCP server implementation. The changes make it easier for users to find comprehensive setup information and understand supported environments.

Documentation improvements:

  • Added a prominent link to a new INSTALLATION.md guide, which provides detailed instructions for over 50 MCP-compatible environments.
  • Introduced a "Popular Platforms" section listing supported desktop AI tools, editors, extensions, cloud providers, containers, mobile platforms, and enterprise integrations, making platform coverage clear to users.
image

Fixes firecrawl/firecrawl#2176

- Created detailed INSTALLATION.md with step-by-step instructions
- Added support for all major MCP-compatible platforms including:
  - Desktop AI: Claude Desktop, Claude Code CLI
  - Editors: Cursor, VS Code, Windsurf, Zed, IntelliJ IDEA, PyCharm, etc.
  - Extensions: Cline, Continue.dev, CodeGPT, GitHub Copilot
  - Cloud: AWS, Azure, GCP, Replit
  - Containers: Docker, Kubernetes
  - Mobile: iOS, Android
  - Enterprise: Slack, Teams, Discord
- Used Context7-style collapsible format with proper icons
- Added both remote and local server configuration options
- Included prerequisites, verification steps, and troubleshooting
- Updated README.md with prominent link to installation guide

Resolves #2176
- Added proper Discord favicon URL to replace empty src
- All platform icons are now properly configured and should display correctly
- Replace Discord icon with proper high-quality favicon
- Maintain 16x16 sizing with correct alignment styling
@MAVRICK-1
Copy link
Contributor Author

@ericciarla can i get a review on this Pr

@nickscamara
Copy link
Member

Hey, please provide the installation guides in the readme itself and not in separate file(s). Also please make sure to test in each platform. Thank you!

@MAVRICK-1
Copy link
Contributor Author

MAVRICK-1 commented Sep 26, 2025

@nickscamara you mean to add about the installation directly into readme.md? No other file

- Integrated all 31 platform installation guides directly into README.md
- Removed separate INSTALLATION.md file as requested in review
- Maintained all platform configurations with proper icons and formatting
- Includes detailed setup instructions for:
  - Desktop AI: Claude Desktop, Claude Code CLI
  - Editors: Cursor, VS Code, Windsurf, Zed, IntelliJ IDEA, PyCharm, WebStorm
  - Extensions: Cline, Continue.dev, CodeGPT, GitHub Copilot
  - Cloud: AWS Lambda, Azure Functions, Google Cloud Functions
  - Container: Docker, Kubernetes
  - Enterprise: Slack Bot, Discord Bot
  - Mobile: iOS, Android
  - And many more platforms

Addresses reviewer feedback to consolidate installation guides
@MAVRICK-1 MAVRICK-1 force-pushed the feature/comprehensive-installation-guide branch from 17fbc7c to 1d46bc2 Compare September 26, 2025 07:04
- Consolidated PyCharm, WebStorm, and Android Studio into single JetBrains IDEs section
- All use the same configuration as IntelliJ IDEA
- Eliminates redundancy while maintaining comprehensive coverage
- Reduced from 31 to 28 unique platform sections
@MAVRICK-1
Copy link
Contributor Author

@nickscamara already tested

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.

Add Installation Instructions to Firecrawl MCP for All MCP-Compatible Environments
2 participants