From b2fdbfa99fc878620b47d9bbc1260a4398437e5b Mon Sep 17 00:00:00 2001
From: MiniDay <372403923@qq.com>
Date: Thu, 4 Jan 2024 13:58:18 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 50 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 070d30d..4e3c8bc 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,22 @@
-# [HamsterCore](https://gitee.com/MiniDay/hamster-core)
+# [HamsterCore](https://git.airgame.net/MiniDay/hamster-core)
 
 仓鼠核心：叁只仓鼠的 Minecraft 插件开发通用工具包
 
-# 添加依赖
+# 手动构建
 
-## Gradle (`build.gradle`)
+1. 将源代码下载或克隆至本地
+2. 在源代码根目录中打开命令行窗口
+3. 命令行窗口中执行`./gradlew clean build`
+4. 构建成品在 `build` 文件夹
+
+也可访问我的[Jenkins网站](https://jenkins.airgame.net/job/opensource/job/hamster-core/)获取最新版
+
+# 开发
+
+## 添加依赖
+
+<details>
+  <summary>Gradle(build.gradle)</summary>
 
 ```groovy
 // 添加仓库
@@ -22,7 +34,31 @@ dependencies {
 }
 ```
 
-## Maven (`pom.xml`)
+</details>
+
+<details>
+  <summary>Gradle(build.gradle.kts)</summary>
+
+```kotlin
+// 添加仓库
+repositories {
+    maven {
+        url = uri("https://maven.airgame.net/maven-public/")
+    }
+}
+
+dependencies {
+    // 对于 Bukkit 插件
+    compileOnly("cn.hamster3.mc.plugin:core-bukkit:+")
+    // 对于 BungeeCord 插件
+    compileOnly("cn.hamster3.mc.plugin:core-bungee:+")
+}
+```
+
+</details>
+
+<details>
+  <summary>Gradle(pom.xml)</summary>
 
 ```xml
 
@@ -52,3 +88,13 @@ dependencies {
     </dependencies>
 </project>
 ```
+
+</details>
+
+## 使用 API
+
+- 绝大部分 API 相关的方法都位于 `cn.hamster3.mc.plugin.core.common.api.CoreAPI` 类中
+    - 使用方法为：`CoreAPI.getInstance().xxx()`
+- 部分通用的工具代码在 `cn.hamster3.mc.plugin.core.common.util` 包中
+- 部分Bukkit的工具代码在 `cn.hamster3.mc.plugin.core.bukkit.util` 包中
+- 部分BungeeCord的工具代码在 `cn.hamster3.mc.plugin.core.bungee.util` 包中
\ No newline at end of file