From 40ec299c64756cf723b3d5e4e58b4b2b30512ccb Mon Sep 17 00:00:00 2001 From: CarmJos Date: Fri, 20 May 2022 21:59:56 +0800 Subject: [PATCH] docs(parent): Update dependency documents --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8acd061..88a99b3 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,17 @@ EasyConfiguration for MineCraft! ### **MineConfiguration-Common** 全部版本的共用部分,包括 + - `ConfigMessage` (实现类为 `ConfiguredMessage`) - `ConfigMessageList` (实现类为 `ConfiguredMessageList`) 如要使用,请访问对应实现类的builder() 方法来快速创建。 -### **MineConfiguration-CraftBukkit** +### MineConfiguration-Bukkit -CraftBukkit系通用依赖,不包含实现部分,请使用 **MineConfiguration-Bukkit** 或 **MineConfiguration-Spigot** 。 +#### MineConfiguration-Bukkit-Base + +Bukkit系通用依赖,不包含实现部分,请使用 **MineConfiguration-Bukkit-General** 或 **MineConfiguration-Bukkit-Native** 。 相较于基础版本,额外提供了以下功能: @@ -40,13 +43,13 @@ CraftBukkit系通用依赖,不包含实现部分,请使用 **MineConfigurati 以上类型可以通过 `CraftConfigValue.builder()` 来创建,部分类型提供了 `of(...);` 方法来快速创建。 -### **MineConfiguration-Bukkit** +#### **MineConfiguration-Bukkit-General** _(推荐)_ 适用于Bukkit的版本,包含以Bukkit为基础的其他服务端 *(如Spigot、Paper、CatServer)* 。 -### **MineConfiguration-Spigot** +#### **MineConfiguration-Bukkit-Native** -适用于 Spigot(1.18+) 的版本,适配了1.18与更新版本自带的配置文件注释功能,随Spigot更新而优化,安全稳定。 +适用于 Spigot(1.18+) 的版本,适配了1.18及以后版本Spigot原生自带的配置文件注释功能,随Spigot更新而优化,安全稳定。 ### **MineConfiguration-Bungee** @@ -56,7 +59,8 @@ CraftBukkit系通用依赖,不包含实现部分,请使用 **MineConfigurati ## 开发 -请详见 [EasyConfiguration](https://github.com/CarmJos/EasyConfiguration) 的 [开发介绍](https://github.com/CarmJos/EasyConfiguration/tree/master/.documentation) 。 +请详见 [EasyConfiguration](https://github.com/CarmJos/EasyConfiguration) +的 [开发介绍](https://github.com/CarmJos/EasyConfiguration/tree/master/.documentation) 。 ### 依赖方式 @@ -107,14 +111,14 @@ CraftBukkit系通用依赖,不包含实现部分,请使用 **MineConfigurati cc.carm.lib - mineconfiguration-bukkit + mineconfiguration-bukkit-general [LATEST RELEASE] compile - + cc.carm.lib - mineconfiguration-spigot + mineconfiguration-bukkit-native [LATEST RELEASE] compile @@ -160,9 +164,9 @@ repositories { dependencies { - api "cc.carm.lib:mineconfiguration-bukkit:[LATEST RELEASE]" + api "cc.carm.lib:mineconfiguration-bukkit-general:[LATEST RELEASE]" - api "cc.carm.lib:mineconfiguration-spigot:[LATEST RELEASE]" + api "cc.carm.lib:mineconfiguration-bukkit-native:[LATEST RELEASE]" api "cc.carm.lib:mineconfiguration-bungee:[LATEST RELEASE]"