From d676c6e0c7f40c48f05408bebd9f624b1ebd6050 Mon Sep 17 00:00:00 2001 From: zy Date: Wed, 17 Sep 2025 22:47:37 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=90=8C=E6=AD=A5=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E8=8B=B1=E6=96=87=E7=89=88=20README=20=E4=B8=8E=E4=B8=AD?= =?UTF-8?q?=E6=96=87=E7=89=88=E4=BF=9D=E6=8C=81=E4=B8=80=E8=87=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 添加预编译二进制文件下载说明(主程序 + 登录工具) - 更新快速开始部分,区分二进制文件和源码编译两种方式 - 添加浏览器自动下载提示 - 更新贡献者列表(6 位贡献者) - 更新社区群组信息(添加微信群 3) - 完善 MCP 客户端接入文档 - 保持与中文版 README 完全同步 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README_EN.md | 111 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 99 insertions(+), 12 deletions(-) diff --git a/README_EN.md b/README_EN.md index 4d6fb3e..befddc6 100644 --- a/README_EN.md +++ b/README_EN.md @@ -1,4 +1,7 @@ # xiaohongshu-mcp + +[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-) + MCP for RedNote (Xiaohongshu) platform. @@ -135,10 +138,41 @@ Results after about a week ## 1. Usage Tutorial -### 1.1. Installation +### 1.1. Quick Start (Recommended) + +**Method 1: Download Pre-compiled Binaries** + +Download pre-compiled binaries for your platform directly from [GitHub Releases](https://github.com/xpzouying/xiaohongshu-mcp/releases): + +**Main Program (MCP Service):** +- **macOS Apple Silicon**: `xiaohongshu-mcp-darwin-arm64` +- **macOS Intel**: `xiaohongshu-mcp-darwin-amd64` +- **Windows x64**: `xiaohongshu-mcp-windows-amd64.exe` +- **Linux x64**: `xiaohongshu-mcp-linux-amd64` + +**Login Tool:** +- **macOS Apple Silicon**: `xiaohongshu-login-darwin-arm64` +- **macOS Intel**: `xiaohongshu-login-darwin-amd64` +- **Windows x64**: `xiaohongshu-login-windows-amd64.exe` +- **Linux x64**: `xiaohongshu-login-linux-amd64` + +Usage Steps: +```bash +# 1. First run the login tool +chmod +x xiaohongshu-login-darwin-arm64 +./xiaohongshu-login-darwin-arm64 + +# 2. Then start the MCP service +chmod +x xiaohongshu-mcp-darwin-arm64 +./xiaohongshu-mcp-darwin-arm64 +``` + +**⚠️ Important Note**: The headless browser will be automatically downloaded on first run (about 150MB), please ensure a stable network connection. Subsequent runs will not require re-downloading. + +**Method 2: Build from Source**
-Installation Configuration Details +Build from Source Details Requires Golang environment. For installation instructions, please refer to [Golang Official Documentation](https://go.dev/doc/install). @@ -165,8 +199,13 @@ For Windows issues, check here first: [Windows Installation Guide](./docs/window First time requires manual login to save RedNote login status. -Run +**Using Binary Files:** +```bash +# Run the login tool for your platform +./xiaohongshu-login-darwin-arm64 +``` +**Using Source Code:** ```bash go run cmd/login/main.go ``` @@ -175,8 +214,17 @@ go run cmd/login/main.go Start xiaohongshu-mcp service. +**Using Binary Files:** ```bash +# Default: Headless mode, no browser interface +./xiaohongshu-mcp-darwin-arm64 +# Non-headless mode, with browser interface +./xiaohongshu-mcp-darwin-arm64 -headless=false +``` + +**Using Source Code:** +```bash # Default: Headless mode, no browser interface go run . @@ -458,20 +506,59 @@ Switched to Feishu group, scan QR code to join directly
- +
+ 【WeChat Group 1】Full -| 【Feishu Group 2】: Scan to join | 【WeChat Group】: Scan to join | + WechatIMG119 + +
+ +
+ 【WeChat Group 2】Full + + WechatIMG119 + +
+ + + +| 【Feishu Group 2】: Scan to join | 【WeChat Group 3】: Scan to join | | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| qrcode_2qun | WechatIMG119 | +| qrcode_2qun | WechatIMG119 | -## 🙏 Thanks to Contributors -Thanks to all friends who have contributed to this project! +## 🙏 Thanks to Contributors ✨ + +Thanks to all friends who have contributed to this project! (In no particular order) + + + + + + + + + + + + + + + +
zy
zy

💻 🤔 📖 🎨 🚧 🚇 👀
clearwater
clearwater

💻
Zhongpeng
Zhongpeng

💻
Duong Tran
Duong Tran

💻
Angiin
Angiin

💻
Henan Mu
Henan Mu

💻
+ + + + + - - - ### ✨ Special Thanks -- [@wanpengxie](https://github.com/wanpengxie) \ No newline at end of file +| Contributors | +| --- | +| [
@wanpengxie](https://github.com/wanpengxie) | + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file