Skip to content

Commit f600d69

Browse files
author
54895y
committed
Refresh MatrixLib public README
1 parent d0a92f4 commit f600d69

1 file changed

Lines changed: 26 additions & 19 deletions

File tree

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,47 @@
11
# MatrixLib
22

3-
`MatrixLib` 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层和共享菜单能力
3+
`MatrixLib` 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层与共享菜单能力
44

5-
它的目标是把 `MatrixShop``MatrixAuth``MatrixCook` 中重复、稳定、可复用的基础设施沉淀出来,减少重复实现,统一后续维护入口
5+
它负责承载 `MatrixShop``MatrixAuth``MatrixCook` 中重复、稳定、可复用的基础设施,减少重复造轮子,并统一后续维护入口
66

7-
## 提供能力
7+
## 核心能力
88

99
- 共享 `branding / console / text / yaml` 能力
1010
- 共享 `menu / compat / action` API
11-
- 统一终端 banner 与中文生命周期输出
11+
- 统一中文终端 banner 与生命周期输出
1212
- 统一 Bukkit / Folia 兼容桥接
1313

14-
## GitHub 源码构建
14+
## 下游构建方式
1515

16-
`MatrixLib` 现在作为公开 GitHub 仓库提供给下游插件直接参与构建。
16+
下游仓库统一依赖坐标:
1717

18-
下游仓库的 `settings.gradle.kts` 已支持两种模式:
18+
- `com.y54895.matrixlib:matrixlib-api:1.0.1`
19+
20+
当前支持两种构建模式:
1921

20-
1. 本地开发模式
22+
1. 本地联动模式
2123
如果工作区存在本地 `MatrixLib` 目录,则优先通过 `includeBuild` 直接联动本地源码。
22-
2. GitHub 构建模式
24+
2. GitHub 源码模式
2325
如果本地没有 `MatrixLib` 目录,则 Gradle 会通过 `sourceControl` 从 GitHub 拉取 `MatrixLib` 源码参与构建。
2426

25-
当前公开标签
27+
参考配置
2628

27-
- `1.0.1`
29+
```kotlin
30+
val matrixLibModule = "com.y54895.matrixlib:matrixlib-api"
2831

29-
当前依赖坐标:
30-
31-
- `com.y54895.matrixlib:matrixlib-api:1.0.1`
32+
sourceControl {
33+
gitRepository(uri("https://github.com/54895y/MatrixLib.git")) {
34+
producesModule(matrixLibModule)
35+
}
36+
}
37+
```
3238

33-
GitHub 仓库地址:
39+
## 当前发布
3440

35-
- Repo: [https://github.com/54895y/MatrixLib](https://github.com/54895y/MatrixLib)
41+
- 首个公开发布版本:`1.0.1`
42+
- GitHub Repo: [https://github.com/54895y/MatrixLib](https://github.com/54895y/MatrixLib)
3643

37-
## Wiki
44+
## 文档
3845

39-
- 项目文档由站点仓库维护
40-
- 说明: 当前不以 GitHub Wiki 或独立 `wiki` 仓库作为文档入口
46+
- 开发文档由 `MatrixDevDocs` 仓库统一维护
47+
- Wiki 入口以仓库主页和文档仓库为准

0 commit comments

Comments
 (0)