From 1cca96ee5a5c8e57927106a799ec5e9957b39389 Mon Sep 17 00:00:00 2001
From: CarmJos <KarmunJ@outlook.com>
Date: Tue, 14 Dec 2021 04:32:11 +0800
Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85=E4=BE=9D=E8=B5=96=E6=96=B9?=
 =?UTF-8?q?=E5=BC=8F?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 74 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 527a8cb..6b7c8fb 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,81 @@
 
 # EasySQL
 
-简单便捷的数据库操作工具，采用 [BeeCP](https://github.com/Chris2018998/BeeCP) 连接池。
+简单便捷的数据库操作工具，可自定义连接池来源。
+
+随项目分别提供 [BeeCP](https://github.com/Chris2018998/BeeCP) 与 [Hikari](https://github.com/brettwooldridge/HikariCP~~~~)
+两个连接池的版本。
+
+## 优势
+
+- 基于JDBC开发，可自选连接池、JDBC驱动。
+- 简单便捷的增删改查接口，无需手写SQL语句。
+- 额外提供部分常用情况的SQL操作
+    - 存在则更新，不存在则插入
+    - 创建表
+    - 修改表
+    - ...
+- 支持同步操作与异步操作
+
+## 依赖方式
+
+### Maven
+
+```xml
+
+<project>
+    <repositories>
+        <repository>
+            <id>github</id>
+            <name>GitHub Packages</name>
+            <url>https://maven.pkg.github.com/CarmJos/EasySQL</url>
+        </repository>
+    </repositories>
+    <dependencies>
+        <!--对于需要提供公共接口的项目，可以仅打包API部分，方便他人调用-->
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>easysql-api</artifactId>
+            <version>[LATEST VERSION]</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <!--如需自定义连接池，则可以仅打包实现部分，自行创建SQLManager-->
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>easysql-impl</artifactId>
+            <version>[LATEST VERSION]</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <!--如需自定义连接池，则可以仅打包实现部分，自行创建SQLManager-->
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>easysql-beecp</artifactId>
+            <version>[LATEST VERSION]</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <!--也可直接选择打包了连接池的版本-->
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>easysql-beecp</artifactId>
+            <version>[LATEST VERSION]</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>cc.carm.lib</groupId>
+            <artifactId>easysql-hikaricp</artifactId>
+            <version>[LATEST VERSION]</version>
+            <scope>compile</scope>
+        </dependency>
+
+    </dependencies>
+</project>
+
+```
+
 
-## 开发
 
 ## 支持与捐赠