From 9948357f52ae1eb792e9de54b47192d492cf51ac Mon Sep 17 00:00:00 2001
From: ceo <ceo@alterminal.com>
Date: Thu, 10 Sep 2026 10:48:12 +0800
Subject: [PATCH] =?UTF-8?q?docs=EF=BC=9AREADME=20=E8=A3=9C=E4=B8=8A?=
 =?UTF-8?q?=E5=AE=8C=E6=95=B4=E5=AE=89=E8=A3=9D=E6=8C=87=E5=8D=97=EF=BC=88?=
 =?UTF-8?q?#15=EF=BC=89?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b41b8f1..9a30ab3 100644
--- a/README.md
+++ b/README.md
@@ -11,12 +11,47 @@ teai 是 Gitea 的命令列（CLI）工具，以更完整、更可靠的方式
 
 ## 安裝與建置
 
-需要 Go 1.26 以上。
+### 需求
+
+- **Go 1.26 以上**（`go version` 確認；本倉庫僅用標準庫，離線可建置）
+- **git**
+- Gitea 帳號的 **API token**（設定階段使用；在 Gitea「設定 → 應用程式」產生）
+
+### 從原始碼建置
 
 ```sh
+git clone https://gitea.alterminal.com/alterminal/teai.git
+cd teai
 go build -o teai ./cmd/teai
+install -Dm755 teai ~/.local/bin/teai   # 或複製到任何 PATH 內目錄
+teai version                             # 驗證：teai version 0.1.0-dev
 ```
 
+也可以直接裝進 `GOBIN`（預設 `~/go/bin`；該目錄已在 PATH 時最省事）：
+
+```sh
+go install ./cmd/teai
+```
+
+> **注意：** `go install gitea.alterminal.com/alterminal/teai/cmd/teai@latest` 目前**不可用**——
+> module 尚未發佈任何 tag，`@latest` 會解析到任意中繼 commit（且 #21 修復前 main 建置失敗）。
+> 請在 clone 目錄內以版本控制的方式建置；發佈 tag 後再提供 `teai@<version>` 安裝路徑。
+
+### 登入設定（首次使用）
+
+teai 與 `tea` 共用同一份組態檔；若 `tea whoami` 已可正常輸出，可跳過本節。
+
+```sh
+teai login add --url https://gitea.alterminal.com
+# 未給 --token 時自 stdin 讀一行：貼上 token 後按 Enter（不會進 shell 歷史）
+teai whoami    # 驗證：應輸出 {"username":"<你的帳號>"}
+```
+
+- token 驗證失敗（HTTP 401）不會寫入組態，結束碼 3。
+- 組態檔：`--config`／`TEA_CONFIG` 指定，預設 `~/.config/tea/config.yml`；teai 採行級編輯，
+  不會改壞 tea 也在使用的欄位，檔案權限 `0600`。
+- 多站台以 `--name` 區分、`teai login default <名稱>` 切換預設；詳見下方 [`teai login`](#teai-login--管理登入) 一節。
+
 ## 指令設計
 
 > 工作流規則的唯一來源是 [`alterminal/agents`](https://gitea.alterminal.com/alterminal/agents) 的 `AGENTS.md`；
-- 
2.54.0