diff --git a/README_EN.md b/README_EN.md index 10be2b1..c98a9e4 100644 --- a/README_EN.md +++ b/README_EN.md @@ -1,7 +1,15 @@
AI-native professional capability enhancement system
-Provides specialized roles, memory management, and knowledge systems for AI applications through MCP protocol
+Provides specialized roles, memory management, and knowledge systems for AI applications through MCP protocol. One command to transform any AI client into a professional powerhouse.
+ + +ไธญๆ | @@ -10,41 +18,50 @@
-[ไธญๆ](README.md) | **English** | [Issues](https://github.com/Deepractice/PromptX/issues)
+#### **2. Intelligent Memory**
+*Use `promptx_remember` to save key information, and AI will proactively apply this knowledge in subsequent interactions.*
+
-## ๐ Quick Start - Direct AI Application Integration
+---
-### ๐ **MCP Standardized Integration**
+## ๐ **Quick Start - 30-Second Setup**
-# Configure MCP connection in AI applications (minimal setup)
-
-#### **โก Zero-Configuration Integration (Recommended)**
-Add to your AI application's MCP configuration file:
+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.
```json
{
"mcpServers": {
"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"]
}
}
}
```
-**๐ฏ That's it!** PromptX automatically:
-- โ
**Intelligent workspace detection** - Automatically finds suitable workspace
-- โ
**Auto environment initialization** - No manual folder/config creation needed
-- โ
**Dynamic project adaptation** - Works seamlessly across different projects
+**๐ฏ It's that simple!** Save the file and restart your AI application, and PromptX is successfully activated.
-#### **๐ง Advanced Configuration (Optional)**
-For custom configurations:
+๐ง If you want to specify a particular folder as PromptX's workspace, you can add the `env` environment variable.
```json
{
@@ -53,6 +70,9 @@ For custom configurations:
"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"
}
}
@@ -60,16 +80,43 @@ For custom configurations:
}
```
+
@@ -141,22 +173,27 @@ For custom configurations:
**Official Website:** https://www.legacylands.cn/
**Organization Description:** Legacy Lands is an innovative team focused on building large-scale Minecraft civilization simulation experiences. They participate in the open-source community, providing elegant, efficient, and reliable solutions for Minecraft server plugin development and other domains.
-#### ๐ก User Experience
+> #### **๐ก Core Developer Experience**
+> "The development experience with PromptX is truly different. Our team, using Claude Code combined with PromptX, had one developer complete over eleven thousand lines of high-quality Java code in just three days.
+>
+> The value of this workflow is fully demonstrated in actual development. PromptX solves many pain points in AI usage, consistently ensuring code style uniformity and quality standards, greatly reducing the learning curve for new team members. Best practices that previously required repeated communication and documentation inheritance can now naturally integrate into every code generation."
-The development experience with PromptX is truly different. Our team, using Claude Code combined with PromptX, had one developer complete over eleven thousand lines of high-quality Java code in just three days.
+#### **๐ Related Resources**
-The value of this workflow is fully demonstrated in actual development. PromptX solves many pain points in AI usage, consistently ensuring code style uniformity and quality standards, greatly reducing the learning curve for new team members. Best practices that previously required repeated communication and documentation inheritance can now naturally integrate into every code generation.
+- **AI Integration Standards and Practice Guide:** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md
-#### ๐ Related Resources
+---
-**AI Integration Standards and Practice Guide:** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md
-
-## โญ Star Growth Trend
+## โญ **Star Growth Trend**
[](https://star-history.com/#Deepractice/PromptX&Date)
-### **Contributing Guidelines**
-- ๐ **[Contributing Process](CONTRIBUTING.md)** - Detailed contribution guide and code standards
+---
+
+### **๐ค Contributing and Communication**
+
+We welcome any form of contribution and feedback!
+
- ๐ฟ **[Branching Strategy](docs/BRANCHING.md)** - Branch management and release process
- ๐ **[Release Process](docs/RELEASE.md)** - Version management and release documentation
@@ -164,9 +201,11 @@ Join our technical community:
-## ๐ License
+---
-MIT License - Making AI professional capabilities accessible
+## ๐ **License**
+
+[MIT License](LICENSE) - Making AI professional capabilities accessible
---