修改 v3.0 版本的文档

blinkfox · Nov 6, 2023 · 80d2273 · 80d2273
1 parent fecc26a
commit 80d2273
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -32,22 +32,36 @@
 
 如果你**不是 Spring Boot 项目**，请参看[这里](https://blinkfox.github.io/fenix/#/quick-install?id=not-spring-boot-project) 的配置方式。
 
-> **注**：请确保你使用的 Spring Boot 版本是 **`v2.1.5.RELEASE` 及以上**，如果 Spring Boot 版本是 `v2.2.x.RELEASE` 及以上，则 Fenix 版本必须是 `v2.0.0` 版本及以上。
+> **注**：请确保你使用的 Spring Boot 版本是 **`v2.1.5.RELEASE` 及以上**。
+> - 如果 Spring Boot 版本是 `v2.2.x.RELEASE` 及以上，则 Fenix 版本必须是 `v2.x` 的版本。
+> - 如果 Spring Boot 版本是 `v3.0.0` 及以上，则 Fenix 版本必须是 `v3.x` 的版本。
 
 ### 🌾 1. Maven
 
 ```xml
+<!-- Spring Boot 版本要求 3.0 及以上. -->
 <dependency>
     <groupId>com.blinkfox</groupId>
     <artifactId>fenix-spring-boot-starter</artifactId>
     <version>3.0.0</version>
 </dependency>
+
+<!-- Spring Boot 版本要求 2.x 版本. -->
+<dependency>
+    <groupId>com.blinkfox</groupId>
+    <artifactId>fenix-spring-boot-starter</artifactId>
+    <version>2.7.0</version>
+</dependency>
 ```
 
 ### 🌵 2. Gradle
 
 ```bash
+// Spring Boot 版本要求 3.x 版本.
 compile 'com.blinkfox:fenix-spring-boot-starter:3.0.0'
+
+// Spring Boot 版本要求 2.x 版本.
+compile 'com.blinkfox:fenix-spring-boot-starter:2.7.0'
 ```
 
 ### 🏕️ 3. 激活 Fenix (@EnableFenix)

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,6 +1,10 @@
 # 🍹 版本更新记录 :id=title
 
-### 🏖️ v2.7.0 新增 ActiveRecord 模式和多种结果转换策略 🆕 (2022-03-31) :id=v270
+### ⛵ v3.0.0 适配 SpringBoot 3.x 的版本 🆕 (2023-11-xx) :id=v300
+
+- 新增适配了 SpringBoot 3.x 的版本；
+
+### 🏖️ v2.7.0 新增 ActiveRecord 模式和多种结果转换策略 (2022-03-31) :id=v270
 
 - 新增了 ActiveRecord 模式，简单场景的“**增删改查**”或**动态查询**更加方便、优雅；
 - 新增了多种可自定义的查询结果列转换为对象实体的转换策略，包括"**基于 as 别名转换**"（默认）、"**下换线转驼峰**"、"**去除前缀的下划线转驼峰**"和"**基于 Column 注解转换**"等；

diff --git a/docs/quick-install.md b/docs/quick-install.md
@@ -8,22 +8,34 @@
 
 如果你是 Spring Boot 项目，那么直接集成 `fenix-spring-boot-starter` 库，并使用 `@EnableFenix` 激活 Fenix 的相关配置信息。
 
-!> **💡 注**：请确保你使用的 Spring Boot 版本是 **`v2.1.5.RELEASE` 及以上**，如果 Spring Boot 版本是 `v2.2.x.RELEASE` 及以上，则 Fenix 版本必须是 `v2.0.0` 版本及以上。
+!> **💡 注**：请确保你使用的 Spring Boot 版本是 **`v2.1.5.RELEASE` 及以上**。如果 Spring Boot 版本是 `v2.2.x.RELEASE` 及以上，则 Fenix 版本必须是 `v2.x` 的版本。如果 Spring Boot 版本是 `v3.0.0` 及以上，则 Fenix 版本必须是 `v3.x` 的版本。
 
 ### 🌾 1. Maven :id=spring-boot-maven
 
 ```xml
+<!-- Spring Boot 版本要求 3.0 及以上. -->
 <dependency>
     <groupId>com.blinkfox</groupId>
     <artifactId>fenix-spring-boot-starter</artifactId>
     <version>3.0.0</version>
 </dependency>
+
+<!-- Spring Boot 版本要求 2.x 版本. -->
+<dependency>
+    <groupId>com.blinkfox</groupId>
+    <artifactId>fenix-spring-boot-starter</artifactId>
+    <version>2.7.0</version>
+</dependency>
 ```
 
 ### 🌵 2. Gradle :id=spring-boot-gradle
 
-```bash
+```gradle
+// Spring Boot 版本要求 3.x 版本.
 compile 'com.blinkfox:fenix-spring-boot-starter:3.0.0'
+
+// Spring Boot 版本要求 2.x 版本.
+compile 'com.blinkfox:fenix-spring-boot-starter:2.7.0'
 ```
 
 ### 🏕️ 3. 激活 Fenix (@EnableFenix) :id=enable-fenix
@@ -97,17 +109,29 @@ fenix:
 ### 🌼 1. Maven :id=project-maven
 
 ```xml
+<!-- Spring Boot 版本要求 3.0 及以上. -->
 <dependency>
     <groupId>com.blinkfox</groupId>
     <artifactId>fenix</artifactId>
     <version>3.0.0</version>
 </dependency>
+
+<!-- Spring Boot 版本要求 2.x 版本. -->
+<dependency>
+    <groupId>com.blinkfox</groupId>
+    <artifactId>fenix</artifactId>
+    <version>2.7.0</version>
+</dependency>
 ```
 
 ### 🌻 2. Gradle :id=project-gradle
 
-```bash
+```gradle
+// Spring Boot 版本要求 3.x 版本.
 compile 'com.blinkfox:fenix:3.0.0'
+
+// Spring Boot 版本要求 2.x 版本.
+compile 'com.blinkfox:fenix:2.7.0'
 ```
 
 ### 🏔️ 3. 激活 Fenix :id=project-enable-fenix