From e001050f1505ba1b4ed834f8f7e928502c9b2e40 Mon Sep 17 00:00:00 2001
From: carm <carm@carm.cc>
Date: Mon, 19 Dec 2022 19:05:13 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=E5=BC=80=E5=8F=91?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 54 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 231a3df..f776306 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,11 @@
 ### 对于服主 (插件使用者)
 
 - 统一配置数据库连接，避免重复配置费时费力分神。
-- 支持更高级更全面的配置方式，以根据不同的使用场景独立优化[连接池配置](https://github.com/Chris2018998/BeeCP/wiki/Configuration--List)。
+-
+
+支持更高级更全面的配置方式，以根据不同的使用场景独立优化[连接池配置](https://github.com/Chris2018998/BeeCP/wiki/Configuration--List)
+。
+
 - 使相关插件共用连接池，避免每个插件单独新开连接池导致资源的浪费。
 
 ### 对于插件开发者
@@ -38,7 +42,8 @@
 
 ## 安装
 
-1. 从 [Releases(发行)](https://github.com/CarmJos/MineSQL/releases/) 中点击 [最新版](https://github.com/CarmJos/MineSQL/releases/latest) 下载 `MineSQL-x.y.z.jar` 。
+1. 从 [Releases(发行)](https://github.com/CarmJos/MineSQL/releases/)
+   中点击 [最新版](https://github.com/CarmJos/MineSQL/releases/latest) 下载 `MineSQL-x.y.z.jar` 。
 2. 将下载的 `MineSQL-x.y.z.jar` 放入服务器 `plugins/` 文件夹下。
 3. 启动服务器，预加载配置文件后关闭服务器。
 4. 修改 `plugins/MineSQL/config.yml` 以配置您的数据库选项。
@@ -90,6 +95,24 @@ Properties 文件的文件名几位数据源的ID，允许为英文、数字、
 
 更多帮助详见 [BeeCP项目帮助](https://github.com/Chris2018998/BeeCP) 。
 
+## 指令
+
+插件主指令为 `/minesql` ，所有指令只允许后台执行。
+
+```text
+# help
+- 查看插件指令帮助。
+
+# version
+- 查看当前插件、核心库(EasySQL)与连接池依赖版本。
+
+# list
+- 列出当前所有的数据源管理器与相关信息。
+
+# info <数据源名称>
+- 查看指定数据源的统计信息与当前仍未关闭的查询。
+```
+
 ## 开发
 
 ### 依赖方式
@@ -163,24 +186,41 @@ dependencies {
 
 </details>
 
-## 指令
+### 操作示例
 
-插件主指令为 `/minesql` ，所有指令只允许后台执行。
+本插件接口入口类为 `MineSQL` ，更多方法详见 [MineSQL-Javadoc](https://carmjos.github.io/MineSQL/) 。
 
-```text
-# help
-- 查看插件指令帮助。
+关于 EasySQL的使用方法，请详见 [EasySQL开发文档](https://github.com/CarmJos/EasySQL/tree/master/.documentation) 。
 
-# version
-- 查看当前插件、核心库(EasySQL)与连接池依赖版本。
 
-# list
-- 列出当前所有的数据源管理器与相关信息。
+<details>
+  <summary>点击查看简单实例</summary>
+
+```java
+
+public class Main extends JavaPlugin {
+
+    @Override
+    public void onEnable() {
+
+        SQLManager manager = MineSQL.getRegistery().get(getConfig().getString("database"));
+
+        if (manager == null) {
+            System.out.println("请配置一个正确的数据库名。");
+            setEnable(false);
+            return;
+        }
+
+        // do something...
+      
+    }
+
+}
 
-# info <数据源名称>
-- 查看指定数据源的统计信息与当前仍未关闭的查询。
 ```
 
+</details> 
+
 ## 开源协议
 
 本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。
@@ -204,4 +244,4 @@ dependencies {
 > @PierreJoye 写的 Practical Guide to GPL Compliance 一文。使用 GPL 协议，你必须在源代码代码中包含相应信息，以及协议本身。
 >
 > *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
-</details>
+</details>