add readme

.env.example

@@ -0,0 +1,16 @@
+# Aster API credentials (必填)
+ASTER_API_KEY=your_api_key
+ASTER_API_SECRET=your_api_secret
+
+# 通用策略配置
+TRADE_SYMBOL=BTCUSDT
+TRADE_AMOUNT=0.001
+LOSS_LIMIT=0.03
+TRAILING_PROFIT=0.2
+TRAILING_CALLBACK_RATE=0.2
+
+# 做市策略可选参数
+MAKER_PRICE_CHASE=0.5
+MAKER_BID_OFFSET=0
+MAKER_ASK_OFFSET=0
+MAKER_REFRESH_INTERVAL_MS=1500

README.md

@@ -1,3 +1,17 @@
+# 快速上手（小白友好版）
+1. 安装 [Bun](https://bun.com) ≥ 1.2，并执行 `bun install` 下载安装依赖。
+2. 复制 `.env.example` 为 `.env` 并填入你的 Aster API Key/Secret，例如：
+   ```bash
+   cp .env.example .env
+   ```
+   然后修改 `.env` 中的配置项（交易对、下单量、风控等）。
+3. 运行机器人：
+   ```bash
+   bun run index.ts
+   ```
+   在终端中按 ↑/↓ 选择 “趋势策略” 或 “做市策略”，回车启动。按 `Esc` 可返回选择菜单，`Ctrl+C` 退出。
+4. 仿真/测试环境建议先设置极小仓位；真实资金请确保 API 仅开启所需权限，并先在低金额下验证策略行为。
+
 # ritmex-bot
 
 A Bun-powered trading workstation for Aster perpetual contracts. The project ships two production strategies—an SMA30 trend follower and a dual-sided maker—that share a modular gateway, UI, and persistence layer. Everything runs in the terminal via Ink, with live websocket refresh and automatic recovery from restarts or network failures.