add README.md, QUICKSTART.md, SUMMARY.md documentation

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-10 10:12:01 +08:00
parent 7d72aed984
commit cc2a67ac82
3 changed files with 269 additions and 0 deletions
--- a/QUICKSTART.md
+++ b/QUICKSTART.md
@@ -0,0 +1,95 @@
+# 快速開始
+
+## 1. 設定環境變數
+
+在專案根目錄建立 `.env`：
+
+```
+BROWSERLESS_ENDPOINT=http://192.168.42.124:13000
+BROWSERLESS_TOKEN=your_token_here
+```
+
+> TWSE 腳本（`twse-*.py`）與 Yahoo 直接 API 腳本不需要此設定，可直接執行。
+
+## 2. 確認 Python 版本
+
+```bash
+python3 --version   # 需要 3.10+
+```
+
+不需要安裝任何第三方套件，全部使用 Python 標準函式庫。
+
+## 3. 測試連線
+
+先測試不需要 Browserless 的腳本：
+
+```bash
+# TWSE 融資融券（不需 Browserless）
+python3 scripts/twse-margin-trading.py 2330
+
+# Yahoo 均線（不需 Browserless）
+python3 scripts/yahoo-ma-signal.py 2330
+```
+
+再測試 Browserless 腳本：
+
+```bash
+# 個股報價（需 Browserless）
+python3 scripts/yahoo-quote-browserless.py 2330
+```
+
+## 4. 常用查詢組合
+
+### 個股速查（三大核心）
+
+```bash
+python3 scripts/yahoo-quote-browserless.py 2330
+python3 scripts/yahoo-institutional-browserless.py 2330
+python3 scripts/yahoo-technical-browserless.py 2330
+```
+
+### 個股深度分析（全套）
+
+```bash
+python3 scripts/yahoo-quote-browserless.py 2330
+python3 scripts/yahoo-institutional-browserless.py 2330
+python3 scripts/yahoo-technical-browserless.py 2330
+python3 scripts/yahoo-dividend-browserless.py 2330
+python3 scripts/yahoo-broker-trading-browserless.py 2330
+python3 scripts/yahoo-ma-signal.py 2330
+python3 scripts/yahoo-macd-signal.py 2330
+python3 scripts/twse-margin-trading.py 2330
+python3 scripts/twse-day-trading.py 2330
+python3 scripts/twse-foreign-holdings.py 2330
+```
+
+### ETF 查詢
+
+```bash
+python3 scripts/yahoo-quote-browserless.py 0050
+python3 scripts/yahoo-etf-holdings.py 0050
+python3 scripts/yahoo-technical-browserless.py 0050
+```
+
+### 大盤
+
+```bash
+python3 scripts/yahoo-market-browserless.py
+```
+
+## 5. 透過 Claude Code 使用
+
+安裝為 skill 後，直接在 Claude Code 中輸入：
+
+- `2330` → 自動執行個股全套分析
+- `0050` → 自動執行 ETF 分析（含持股）
+- `大盤` → 自動執行大盤查詢
+
+## 常見問題
+
+| 問題 | 解法 |
+|------|------|
+| `缺少必要環境變數` | 確認 `.env` 檔存在且格式正確 |
+| `Browserless 導航逾時` | 檢查 Browserless 服務是否正常運作 |
+| `找不到 XXXX 的融資融券資料` | TWSE 假日無資料，腳本會自動回溯 10 個工作日 |
+| `Yahoo API 錯誤` | Yahoo 偶有 rate limit，稍後重試 |