From d7619728b18181ce936f90f3279800205cfc2cd5 Mon Sep 17 00:00:00 2001
From: MiniDay <372403923@qq.com>
Date: Wed, 31 May 2023 06:05:22 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=85=81=E8=AE=B8=E4=BB=8E=E7=8E=AF?=
 =?UTF-8?q?=E5=A2=83=E5=8F=98=E9=87=8F=E4=B8=AD=E8=AF=BB=E5=8F=96=E9=85=8D?=
 =?UTF-8?q?=E7=BD=AE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 28bd86a..8d09e2b 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,18 @@
 
 该插件依赖于 [仓鼠核心](https://gitee.com/MiniDay/hamster-core)
 
+# 环境变量
+
+除了从 `config.yml` 中配置服务器信息以外，本插件还支持从环境变量中读取
+
+| 环境变量名称                 | 描述                | 对应 config 值                   |
+|:-----------------------|:------------------|:------------------------------|
+| BALL_SERVER_HOST       | 服务器唯一识别码，最长 32 字符 | ball-server.host              |
+| BALL_SERVER_PORT       | 服务器唯一识别码，最长 32 字符 | ball-server.port              |
+| BALL_EVENT_LOOP_THREAD | 服务器唯一识别码，最长 32 字符 | ball-server.event-loop-thread |
+| BALL_SERVER_INFO_ID    | 服务器唯一识别码，最长 32 字符 | server-info.id                |
+| BALL_SERVER_INFO_NAME  | 服务端名称，用于展示给玩家看    | server-info.name              |
+
 # 添加依赖
 
 ## Gradle (`build.gradle`)