From 6aa26170df86fda37970899a445d4373f8c36058 Mon Sep 17 00:00:00 2001
From: zhangzhuo <zhangzhuo@acoinfo.com>
Date: Tue, 22 Mar 2022 09:01:04 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 5cb0199..20c7309 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,25 @@
 #### 对应版本号
 `3.0.0`
 
+#### 运行方式
+1. 将`sql/plugin-test-example.sql`文件导入到`mysql`数据库
+2. 修改各个模块对数据库连接配置信息
+3. 打包插件: `mvn clean package`
+4. 进入主程序`example-main` 启动 `Application`
+
+#### 目录说明
+```properties
+example-main: 主程序
+example-plugins-basic: 基本案例插件
+  example-basic-1: 基本案例插件1
+  example-basic-2: 基本案例插件2
+example-plugins-cloud: 微服务案例插件
+  example-plugin-cloud-nacos: 集成nacos案例
+example-plugins-db: 连接数据库案例
+  example-jpa: jpa插件案例
+  example-mybatis-plus: mybatis-plus插件案例
+```
+
 #### 框架源码地址
 [https://gitee.com/starblues/springboot-plugin-framework-parent](https://gitee.com/starblues/springboot-plugin-framework-parent)
 
-- 
Gitee