From a81d8ea3cf1837e45e210203a9275df359c51189 Mon Sep 17 00:00:00 2001
From: MiniDay <372403923@qq.com>
Date: Sun, 23 Oct 2022 05:50:21 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=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 | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6b15252
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# HamsterCore
+
+仓鼠核心：Minecraft 插件开发通用工具包
+
+# 添加依赖
+
+## 对于 Gradle (`build.gradle`)
+
+```groovy
+// 添加仓库
+repositories {
+    maven {
+        url "https://maven.airgame.net/maven-public"
+    }
+}
+
+dependencies {
+    // 对于 Bukkit 插件
+    compileOnly "cn.hamster3.mc.plugin:hamster-core-bukkit:1.0.0"
+    // 对于 BungeeCord 插件
+    compileOnly "cn.hamster3.mc.plugin:hamster-core-bungeecord:1.0.0"
+}
+```
+
+## 对于 Maven (`pom.xml`)
+
+```xml
+
+<project>
+    <!--添加仓库-->
+    <repositories>
+        <repository>
+            <id>airgame-repo-maven-public</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-core-bukkit</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+        <!--对于 BungeeCord 插件-->
+        <dependency>
+            <groupId>cn.hamster3.mc.plugin</groupId>
+            <artifactId>hamster-core-bungeecord</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+    </dependencies>
+</project>
+```