From 940e27e6b9b11980a949437ac1587d7ff606aaf9 Mon Sep 17 00:00:00 2001
From: MiniDay <372403923@qq.com>
Date: Fri, 28 Oct 2022 01:11:57 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E8=87=AA=E8=BF=B0?=
 =?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 | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 55 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8dbef39..a7dd754 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,56 @@
-# HamsterBall
+# [HamsterBall](https://github.com/MiniDay/hamster-ball)
 
-仓鼠球：一个基于 Netty 的 Minecraft 服务端通用消息中间件（原HamsterService）
+仓鼠球：一个基于 Netty 的 Minecraft 服务端通用消息中间件（原HamsterService）  
+
+该插件依赖于 [仓鼠核心](https://github.com/MiniDay/hamster-core)
+
+# 添加依赖
+
+## Gradle (`build.gradle`)
+
+```groovy
+// 添加仓库
+repositories {
+    maven {
+        url "https://maven.airgame.net/maven-public"
+    }
+}
+
+dependencies {
+    // 对于 Bukkit 插件
+    compileOnly "cn.hamster3.mc.plugin:hamster-ball-bukkit:1.0.0"
+    // 对于 BungeeCord 插件
+    compileOnly "cn.hamster3.mc.plugin:hamster-ball-bungeecord:1.0.0"
+}
+```
+
+## Maven (`pom.xml`)
+
+```xml
+
+<project>
+    <!--添加仓库-->
+    <repositories>
+        <repository>
+            <id>airgame-repo</id>
+            <name>AirGame Maven仓库</name>
+            <url>https://maven.airgame.net/maven-public</url>
+        </repository>
+    </repositories>
+
+    <dependencies>
+        <!--对于 Bukkit 插件-->
+        <dependency>
+            <groupId>cn.hamster3.mc.plugin</groupId>
+            <artifactId>hamster-ball-bukkit</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+        <!--对于 BungeeCord 插件-->
+        <dependency>
+            <groupId>cn.hamster3.mc.plugin</groupId>
+            <artifactId>hamster-ball-bungeecord</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+    </dependencies>
+</project>
+```