From dee344909ff4e7b97b2dedd4765a231c68d1f7e3 Mon Sep 17 00:00:00 2001
From: ningmengchongshui <916415899@qq.com>
Date: Sun, 9 Jun 2024 23:45:33 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=8A=A0=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md       | 21 ++++++++++++++++++---
 md/developer.md |  8 ++++++++
 2 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 610734c..6cb1495 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,10 @@
 
 如果你的系统不支持18.18.2版本，最低能下载16.14.0版本，这是最新的puppeteer版本限制。
 
+## 开发者
+
+> [开发相关](./md/developer.md)
+
 ## 使用教程
 
 - 安装源码
@@ -22,6 +26,19 @@
 git clone --depth=1 -b dev https://github.com/yoimiya-kokomi/Miao-Yunzai.git
 ```
 
+- 进入目录
+
+```sh
+cd Miao-Yunzai
+```
+
+- 安装插件(计划移除中...)
+
+```sh
+
+git clone --depth=1 https://github.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
+```
+
 - 安装依赖
 
 ```sh
@@ -41,9 +58,7 @@ npm run ts:app
 npm run ts:app login
 ```
 
-## 开发者
-
-> [开发相关](./md/developer.md)
+> 暂不支持PM2托管进程
 
 ## Unknown file ".ts"
 
diff --git a/md/developer.md b/md/developer.md
index af0df6d..01f66a4 100644
--- a/md/developer.md
+++ b/md/developer.md
@@ -104,6 +104,14 @@ src/mys
 
 src/utils
 
+## 生成开发文档
+
+```sh
+npm run docs
+```
+
+浏览器打开文件`docs/index.html`
+
 ## 新开发示例
 
 > [开发示例](./example.md)