From 6c8ea2b39c3ed2ae972be38b50e4da374ec22baa Mon Sep 17 00:00:00 2001 From: sean Date: Mon, 16 Jun 2025 15:32:15 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README=E6=96=87=E4=BB=B6?= =?UTF-8?q?=EF=BC=8C=E5=A2=9E=E5=8A=A0=E9=A1=B9=E7=9B=AE=E7=8A=B6=E6=80=81?= =?UTF-8?q?=E8=AF=B4=E6=98=8E=E5=92=8C=E6=94=AF=E6=8C=81=E8=81=94=E7=B3=BB?= =?UTF-8?q?=E6=96=B9=E5=BC=8F=EF=BC=8C=E4=BC=98=E5=8C=96=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=E7=A4=BA=E4=BE=8B=EF=BC=8C=E6=98=8E=E7=A1=AE=E4=BD=BF=E7=94=A8?= =?UTF-8?q?=E5=AE=98=E6=96=B9=E9=95=9C=E5=83=8F=E6=BA=90=E4=BB=A5=E9=81=BF?= =?UTF-8?q?=E5=85=8D=E5=AE=89=E8=A3=85=E9=97=AE=E9=A2=98=EF=BC=8C=E5=90=8C?= =?UTF-8?q?=E6=97=B6=E8=B0=83=E6=95=B4=E4=BA=86=E9=83=A8=E5=88=86=E5=86=85?= =?UTF-8?q?=E5=AE=B9=E4=BB=A5=E6=8F=90=E5=8D=87=E7=94=A8=E6=88=B7=E4=BD=93?= =?UTF-8?q?=E9=AA=8C=E5=92=8C=E7=90=86=E8=A7=A3=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 52 +++++++++++++++++++++++++++++----------------------- README_EN.md | 52 +++++++++++++++++++++++++++++----------------------- 2 files changed, 58 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 8caf672..a469ea7 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,24 @@ PromptX 能做什么？简单来说，它让你的 AI 助手拥有了"大脑"和 --- +## ⚠️ **项目状态说明** + +PromptX 目前处于 **初始开发阶段**，我们正在积极完善功能和修复问题。在达到正式稳定版本之前，您可能会遇到一些使用上的问题或不稳定情况。 + +**我们诚恳地请求您的理解和支持！** 🙏 + +### 📞 **遇到问题？获取帮助！** + +如果您在使用过程中遇到任何问题，请通过以下方式联系我们： + +- 🐛 **提交 Issue**: [GitHub Issues](https://github.com/Deepractice/PromptX/issues) - 详细描述问题，我们会尽快回复 +- 💬 **直接联系**: 添加开发者微信 `sean-xie-deepractice` 获取即时帮助 +- 📱 **技术交流群**: 扫描下方二维码加入我们的技术交流群 + +您的反馈对我们非常宝贵，帮助我们快速改进产品质量！ ✨ + +--- + ## 🚀 **一键启动，30秒完成配置** 打开配置文件，将下面的 `promptx` 配置代码复制进去。这是最简单的 **零配置模式**，PromptX 会自动为您处理一切。 @@ -52,8 +70,15 @@ PromptX 能做什么？简单来说，它让你的 AI 助手拥有了"大脑"和 "promptx": { // 指定使用 npx 运行 promptx 服务 "command": "npx", - // '-y' 自动确认, '-f' 强制刷新缓存, 'dpml-prompt@snapshot' 使用最新版, 'mcp-server' 启动服务 - "args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"] + // 启动参数配置 + "args": [ + "-y", // 自动确认 + "-f", // 强制刷新缓存 + "--registry", // 指定镜像源 + "https://registry.npmjs.org", // 使用官方镜像 + "dpml-prompt@beta", // 使用稳定测试版 + "mcp-server" // 启动服务 + ] } } } @@ -61,26 +86,7 @@ PromptX 能做什么？简单来说，它让你的 AI 助手拥有了"大脑"和 **🎯 就这么简单！** 保存文件并重启您的AI应用，PromptX 就已成功激活。 -🔧 如果您想指定一个特定的文件夹作为 PromptX 的工作区，可以添加 `env` 环境变量。 - -```json -{ - "mcpServers": { - "promptx": { - "command": "npx", - "args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"], - "env": { - // PROMPTX_WORKSPACE: 自定义工作空间路径 (可选，系统会自动识别) - // Windows: "D:\\path\\to\\your\\project" (注意使用双反斜杠) - // macOS/Linux: "/Users/username/path/your/project" - "PROMPTX_WORKSPACE": "/your/custom/workspace/path" - } - } - } -} -``` - -
+> **💡 提示：** 配置中特意指定了官方镜像源 `registry.npmjs.org`，这可以避免因使用非官方镜像导致的安装问题。如果您发现安装很慢，建议使用代理工具加速，而不是切换到其他镜像源。 --- @@ -181,7 +187,7 @@ graph TD #### **📚 相关资源** -- **AI集成标准与实践指南：** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md +- **AI集成标准与实践指南：** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHC N.md --- diff --git a/README_EN.md b/README_EN.md index c98a9e4..055caf8 100644 --- a/README_EN.md +++ b/README_EN.md @@ -42,6 +42,24 @@ What can PromptX do? Simply put, it gives your AI assistant a "brain" and "memor --- +## ⚠️ **Project Status Notice** + +PromptX is currently in the **early development stage**, and we are actively improving features and fixing issues. Before reaching the official stable version, you may encounter some usage issues or instability. + +**We sincerely ask for your understanding and support!** 🙏 + +### 📞 **Need Help? Get Support!** + +If you encounter any issues during usage, please contact us through: + +- 🐛 **Submit Issue**: [GitHub Issues](https://github.com/Deepractice/PromptX/issues) - Describe the problem in detail, we'll respond promptly +- 💬 **Direct Contact**: Add developer WeChat `sean-xie-deepractice` for immediate assistance +- 📱 **Tech Community**: Scan the QR code below to join our technical discussion group + +Your feedback is invaluable to us and helps us improve product quality rapidly! ✨ + +--- + ## 🚀 **Quick Start - 30-Second Setup** Open your configuration file and copy the `promptx` configuration code below. This is the simplest **zero-configuration mode**, where PromptX automatically handles everything for you. @@ -52,8 +70,15 @@ Open your configuration file and copy the `promptx` configuration code below. Th "promptx": { // Use npx to run promptx service "command": "npx", - // '-y' auto-confirm, '-f' force refresh cache, 'dpml-prompt@snapshot' use latest version, 'mcp-server' start service - "args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"] + // Startup parameters configuration + "args": [ + "-y", // Auto-confirm + "-f", // Force refresh cache + "--registry", // Specify registry + "https://registry.npmjs.org", // Use official registry + "dpml-prompt@beta", // Use stable beta version + "mcp-server" // Start service + ] } } } @@ -61,24 +86,7 @@ Open your configuration file and copy the `promptx` configuration code below. Th **🎯 It's that simple!** Save the file and restart your AI application, and PromptX is successfully activated. -🔧 If you want to specify a particular folder as PromptX's workspace, you can add the `env` environment variable. - -```json -{ - "mcpServers": { - "promptx": { - "command": "npx", - "args": ["-y", "-f", "dpml-prompt@snapshot", "mcp-server"], - "env": { - // PROMPTX_WORKSPACE: Custom workspace path (optional, automatically detected by default) - // Windows: "D:\\path\\to\\your\\project" (note the double backslashes) - // macOS/Linux: "/Users/username/path/your/project" - "PROMPTX_WORKSPACE": "/your/custom/workspace/path" - } - } - } -} -``` +> **💡 Tip:** The configuration specifically uses the official registry `registry.npmjs.org` to avoid installation issues caused by unofficial mirrors. If you find the installation slow, it's recommended to use a proxy tool for acceleration rather than switching to alternative mirrors.
@@ -209,6 +217,4 @@ Join our technical community: --- -**🚀 Get Started Now: Launch PromptX MCP Server and enhance your AI application with professional capabilities!** - -``` \ No newline at end of file +**🚀 Get Started Now: Launch PromptX MCP Server and enhance your AI application with professional capabilities!** \ No newline at end of file