docs: 更新自述文档

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>
+```