diff --git a/README.md b/README.md index 9dc2256..5c4012d 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ This dashboard reads your local OpenClaw configuration and session data, providi ## Getting Started +See [Quick Start Guide](quick_start.md) for prompt/git/skill startup options. + ```bash # Clone the repo git clone https://github.com/xmanrui/OpenClaw-bot-review.git @@ -133,6 +135,8 @@ docker run -d --name openclaw-dashboard -p 3000:3000 -e OPENCLAW_HOME=/opt/openc ## 快速开始 +更多启动方式请见:[快速启动文档](quick_start.md)。 + ```bash # 克隆仓库 git clone https://github.com/xmanrui/OpenClaw-bot-review.git diff --git a/quick_start.md b/quick_start.md new file mode 100644 index 0000000..6a3e054 --- /dev/null +++ b/quick_start.md @@ -0,0 +1,70 @@ +#快速启动办法(中文) +## 1.通过prompt安装 +``` +在openclaw输入如下提示词,让openclaw帮启动: +请帮我安装并运行这个github项目,并把服务访问地址发给我:https://github.com/xmanrui/OpenClaw-bot-review +``` + +## 2.通过git安装 +``` +git clone https://github.com/xmanrui/OpenClaw-bot-review.git +cd OpenClaw-bot-review +npm install +npm run dev +``` + +## 通过skill安装 +``` +npx clawhub install openclaw-bot-dashboard +或者:npx skills add xmanrui/openclaw-bot-dashboard + +安装后通过这些关键词触发启动服务: +- "打开 OpenClaw-bot-review" +- "打开 Openclaw dashboard" +- "打开 bot review" +- "打开机器人大盘" +- "打开 bot-review" +- "打开openclaw机器人大盘" +- "open openclaw dashboard" +- "open OpenClaw-bot-review" +- "open openclaw dashsboard" +- "launch bot review" +- "start dashboard" + +``` + +--- + +# Quick Start (English) +## 1. Install via Prompt +``` +In OpenClaw, send the prompt below and let OpenClaw set it up: +Please help me install and run this GitHub project, and send me the service URL: https://github.com/xmanrui/OpenClaw-bot-review +``` + +## 2. Install via Git +``` +git clone https://github.com/xmanrui/OpenClaw-bot-review.git +cd OpenClaw-bot-review +npm install +npm run dev +``` + +## 3. Install via Skill +``` +npx clawhub install openclaw-bot-dashboard +or: npx skills add xmanrui/openclaw-bot-dashboard + +After installation, use these trigger phrases to start the service: +- "打开 OpenClaw-bot-review" +- "打开 Openclaw dashboard" +- "打开 bot review" +- "打开机器人大盘" +- "打开 bot-review" +- "打开openclaw机器人大盘" +- "open openclaw dashboard" +- "open OpenClaw-bot-review" +- "open openclaw dashsboard" +- "launch bot review" +- "start dashboard" +```