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.
This commit is contained in:
discountry
2026-02-27 12:47:32 +08:00
parent 4014a86223
commit 674a6fe0da
5 changed files with 9 additions and 6 deletions
+3
View File
@@ -0,0 +1,3 @@
docs/
.claude/
.cursor/
+3 -3
View File
@@ -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)
+3 -3
View File
@@ -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)
View File