From 674a6fe0da5e3d04c1840edf5997b85b99c5e24a Mon Sep 17 00:00:00 2001
From: discountry <feibilanceon@gmail.com>
Date: Fri, 27 Feb 2026 12:47:32 +0800
Subject: [PATCH] Add CLI user guides and .npmignore file

- Introduced English and Chinese user guides for the `ritmex-bot` CLI, detailing command usage and options.
- Created a new `.npmignore` file to exclude documentation directories from npm package distribution.
- Updated README files to link to the new user guides directly, ensuring easy access for users.
---
 .npmignore                              | 3 +++
 README.md                               | 6 +++---
 README_en.md                            | 6 +++---
 docs/cli-guide.en.md => cli-guide.en.md | 0
 docs/cli-guide.md => cli-guide.md       | 0
 5 files changed, 9 insertions(+), 6 deletions(-)
 create mode 100644 .npmignore
 rename docs/cli-guide.en.md => cli-guide.en.md (100%)
 rename docs/cli-guide.md => cli-guide.md (100%)

diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..a667f43
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,3 @@
+docs/
+.claude/
+.cursor/
diff --git a/README.md b/README.md
index 879f21e..0c58680 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend en
 - `--symbol` 原样透传，不对交易对做统一改写。
 - 支持 `--dry-run` 模拟执行与 `--json` 结构化输出，便于自动化系统集成。
 
-完整文档请见：[ritmex-bot CLI 使用手册（中文）](docs/cli-guide.md)
+完整文档请见：[ritmex-bot CLI 使用手册（中文）](cli-guide.md)
 
 如果您希望获取优惠并支持本项目，请考虑使用以下注册链接：
 
@@ -31,8 +31,8 @@ A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend en
 * [Apex 手续费优惠注册链接](https://join.omni.apex.exchange/SEA)
 
 ## 文档索引
-- [ritmex-bot CLI 使用手册（中文）](docs/cli-guide.md)
-- [ritmex-bot CLI User Guide (English)](docs/cli-guide.en.md)
+- [ritmex-bot CLI 使用手册（中文）](cli-guide.md)
+- [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
 - [简明上手指南（零基础）](simple-readme.md)
 - [基础网格策略使用教程](grid-trading.md)
 
diff --git a/README_en.md b/README_en.md
index dc300e5..dd3ec00 100644
--- a/README_en.md
+++ b/README_en.md
@@ -11,7 +11,7 @@ A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend en
 - `--symbol` is passed through exactly as provided (no symbol normalization).
 - It supports `--dry-run` simulation and `--json` structured output for automation.
 
-Full guide: [ritmex-bot CLI User Guide (English)](docs/cli-guide.en.md)
+Full guide: [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
 
 If you'd like to support this project and get fee discounts, please consider using these referral links:
 
@@ -27,8 +27,8 @@ If you'd like to support this project and get fee discounts, please consider usi
 * [Apex referral link](https://join.omni.apex.exchange/SEA)
 
 ## Documentation Map
-- [ritmex-bot CLI User Guide (English)](docs/cli-guide.en.md)
-- [ritmex-bot CLI 使用手册（中文）](docs/cli-guide.md)
+- [ritmex-bot CLI User Guide (English)](cli-guide.en.md)
+- [ritmex-bot CLI 使用手册（中文）](cli-guide.md)
 - [Beginner-friendly Quick Start](simple-readme.md)
 - [Grid Trading Strategy Guide](grid-trading.md)
 
diff --git a/docs/cli-guide.en.md b/cli-guide.en.md
similarity index 100%
rename from docs/cli-guide.en.md
rename to cli-guide.en.md
diff --git a/docs/cli-guide.md b/cli-guide.md
similarity index 100%
rename from docs/cli-guide.md
rename to cli-guide.md