docs CI

zhinjs · Jul 21, 2024 · f9ae0e9 · f9ae0e9
1 parent 5289446
commit f9ae0e9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -22,21 +22,9 @@
 - [x] Email
 - [ ] [KOOK](https://www.kookapp.cn/) (planned)
 - [ ] [Telegram](https://telegram.org) (planned)
-## 快速上手
-### 1. 初始化包管理器
-```shell
-npm init -y # 初始化 package.json 文件
-npm install typescript -D # 安装ts开发环境依赖
-npx tsc --init # 初始化 tsconfig.json 文件
-```
-### 2. 安装zhin
-```shell
-npm install zhin
-```
-### 3. 初始化
-```shell
-npx zhin init --key  # 
-```
+
+## [快速上手](https://docs.zhin.dev/guide/start.html)
+
 ## 友链 (排名不分先后)
 1. 【[onebots](https://onebots.pages.dev)】 (OneBot V11/OneBot V12)
 2. 【[icqq](https://github.com/icqqjs/icqq)】一个NodeJS的qq协议库

diff --git a/docs/src/guide/start.md b/docs/src/guide/start.md
@@ -56,25 +56,25 @@ npx zhin init # 生成zhin配置文件
 默认情况下，zhin仅基本提供命令行适配，添加对应机器人需先安装对应的适配器
 ::: code-group
 ```shell [ICQQ]
-npm install @zhinjs/icqq
+npm install @zhinjs/adapter-icqq
 ```
 ```shell [QQ官方机器人]
-npm install @zhinjs/qq
+npm install @zhinjs/adapter-qq
 ```
 ```shell [onebot-11]
-npm install @zhinjs/onebot-11
+npm install @zhinjs/adapter-onebot-11
 ```
 ```shell [onebot-12]
-npm install @zhinjs/onebot-12
+npm install @zhinjs/adapter-onebot-12
 ```
 ```shell [Discord]
-npm install @zhinjs/discord
+npm install @zhinjs/adapter-discord
 ```
 ```shell [钉钉]
-npm install @zhinjs/dingtalk
+npm install @zhinjs/adapter-dingtalk
 ```
 ```shell [微信]
-npm install @zhinjs/wechat
+npm install @zhinjs/adapter-wechat
 ```
 :::
 
@@ -84,55 +84,55 @@ npm install @zhinjs/wechat
 ```shell [ICQQ]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/icqq # 注册适配器
+adapter.add @zhinjs/adapter-icqq # 注册适配器
 # 等待zhin 自动重启...
 bot.add icqq # 添加bot配置
 # 根据提示添加...
 ```
 ```shell [QQ官方机器人]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/qq # 注册适配器
+adapter.add @zhinjs/adapter-qq # 注册适配器
 # 等待zhin 自动重启...
 bot.add qq # 添加bot配置
 # 根据提示添加...
 ```
 ```shell [onebot-11]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/onebot-11 # 注册适配器
+adapter.add @zhinjs/adapter-onebot-11 # 注册适配器
 # 等待zhin 自动重启...
 bot.add onebot-11 # 添加bot配置
 # 根据提示添加...
 ```
 ```shell [onebot-12]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/onebot-12 # 注册适配器
+adapter.add @zhinjs/adapter-onebot-12 # 注册适配器
 # 等待zhin 自动重启...
 bot.add onebot-12 # 添加bot配置
 # 根据提示添加...
 ```
 ```shell [Discord]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/discord # 注册适配器
+adapter.add @zhinjs/adapter-discord # 注册适配器
 # 等待zhin 自动重启...
 bot.add discord # 添加bot配置
 # 根据提示添加...
 ```
 ```shell [钉钉]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/dingtalk # 注册适配器
+adapter.add @zhinjs/adapter-dingtalk # 注册适配器
 # 等待zhin 自动重启...
 bot.add dingtalk # 添加bot配置
 # 根据提示添加...
 ```
 ```shell [微信]
 npx zhin # 启动zhin
 # 等待启动完成...
-adapter.add @zhinjs/wechat # 注册适配器
+adapter.add @zhinjs/adapter-wechat # 注册适配器
 # 等待zhin 自动重启...
 bot.add wechat # 添加bot配置
 # 根据提示添加...