diff --git a/README.md b/README.md index 3d7785f..2bf8bb2 100644 --- a/README.md +++ b/README.md @@ -22,21 +22,11 @@ > 本プロジェクトは npm に [`bitbank-lab-cli`](https://www.npmjs.com/package/bitbank-lab-cli) として公開済みです。通常利用ではソースのクローンは不要です(開発したい方向けの手順は [開発](#開発) を参照)。 -## 目的別ガイド - -- **使うだけ**(コマンドを叩いて市況を取りたい)→ [クイックスタート](#クイックスタート) / [コマンド一覧](#コマンド一覧) -- **Skill を育てる**(自然言語で操作・カスタマイズしたい)→ [Agent Skills](#agent-skills) / [カスタマイズガイド](docs/customization-guide.md) -- **CLI を開発する**(コマンド追加・コントリビュート)→ [開発](#開発) / [アーキテクチャ](#アーキテクチャ) / [`.claude/rules/commands.md`](.claude/rules/commands.md) -- **paper で bot 検証**(仮想資金で戦略を試したい)→ [Paper](#paperペーパートレード--仮想資金) / [botter 運用 Runbook](docs/botter-runbook.md) - -## 設計思想 - -CLI は bitbank API への**薄いアクセス層**。 -Skills を編集・追加する等、ご自身の用途に合わせてカスタマイズしてください。 - ## 主な提供物 -このリポジトリは **CLI** と **Agent Skills** の 2 層構成です。 +このリポジトリは **CLI** と **Agent Skills** の 2 層構成です。 +CLI は bitbank API への**薄いアクセス層**。 +Skills を編集・追加する等、ご自身の用途に合わせてカスタマイズしてください。 ### 1. bitbank CLI @@ -282,7 +272,9 @@ Trade コマンドは `bitbank trade ` の形で呼び出します ### Paper(ペーパートレード — 仮想資金) -`bitbank paper ` でライブ価格 × 仮想資金のシミュレーションを行います。実 API は public ticker のみ叩き、private / trade エンドポイントには一切触れません。状態は `~/.bitbank/paper-state.json`(または `$XDG_DATA_HOME/bitbank/paper-state.json`)に保存されます。 +`bitbank paper ` でライブ価格 × 仮想資金のシミュレーションを行います。 +実 API は public ticker のみ叩き、private / trade エンドポイントには一切触れません。 +状態は `~/.bitbank/paper-state.json`(または `$XDG_DATA_HOME/bitbank/paper-state.json`)に保存されます。 | コマンド | 説明 | 使用例 | |---------|------|--------|