Skip to content

Commit 4725306

Browse files
authored
Update README.md
1 parent b28d147 commit 4725306

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,39 @@
22

33
基于 [ricq](https://github.com/lz1998/ricq) 的机器人框架,使用 websocket + protobuf 通信。
44

5-
建议直接下载 [Release](https://github.com/ProtobufBot/pbbot-rq/releases) 版本。
5+
6+
## 使用方法
7+
8+
1. 下载 [Release](https://github.com/ProtobufBot/pbbot-rq/releases) 版本。
9+
2. 下载 [PBRQ-UI-Release](https://github.com/ProtobufBot/pbrq-react-ui/releases),并解压 static.zip。
10+
3. 如果是 Linux/MacOS 需要执行 `chmod +x pbbot-rq` 添加权限。
11+
4. 执行 `./pbbot-rq --help` 查看帮助。
12+
5. 执行 `./pbbot-rq --bind-dir 0.0.0.0:9000 --static-dir static` 启动程序,可以自己添加参数开启 跨域、HTTP-BASIC登录 等功能。
13+
6. 打开浏览器访问 `http://localhost:9000` 管理机器人。
14+
7. 首次运行后生成 `plugins` 文件夹,默认连接地址 `ws://localhost:8081/ws/rq/`,修改后重启生效。
15+
16+
17+
```text
18+
├── pbbot-rq.exe
19+
└── static
20+
├── asset-manifest.json
21+
├── favicon.ico
22+
├── index.html
23+
├── logo192.png
24+
├── logo512.png
25+
├── manifest.json
26+
├── robots.txt
27+
└── static
28+
├── css
29+
│   └── main.a14a9148.css
30+
└── js
31+
├── 27.af432e68.chunk.js
32+
├── main.989aee2b.js
33+
└── main.989aee2b.js.LICENSE.txt
34+
```
35+
36+
37+
638

739
## API
840

@@ -75,4 +107,4 @@ cargo +nightly build --release
75107

76108
# 运行
77109
./target/release/main
78-
```
110+
```

0 commit comments

Comments
 (0)