Skip to content

Commit 69b8c2b

Browse files
committed
Update README
1 parent e396d51 commit 69b8c2b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ MVVMFrame for Android 是一个基于Google官方推出的Architecture Component
3131

3232
2. 在Module的 **build.gradle** 里面添加引入依赖项
3333
```gradle
34-
// AndroidX 版本
34+
// AndroidX
3535
implementation 'com.github.jenly1314:mvvmframe:3.0.0'
3636
```
3737

3838
### **Hilt****Room** 的相关注解处理器
3939

40-
因为[mvvmframe](mvvmframe)内部依赖了**Hilt****Room**,所以你需要引入下面列出的编译时的注解处理器,用于自动生成相关代码。
40+
因为 [mvvmframe](mvvmframe) 内部依赖了 **Hilt****Room**,所以你需要引入下面列出的编译时的注解处理器,用于自动生成相关代码。
4141

4242
> 以下配置为当前最新版本的,其它对应版本可查看版本说明,或对应的版本发布 [Versions](https://github.com/jenly1314/MVVMFrame/releases)
4343
@@ -62,23 +62,25 @@ plugins {
6262
dependencies{
6363
//...
6464
65-
// room
66-
kapt "androidx.room:room-compiler:2.6.1"
6765
// hilt
6866
implementation "com.google.dagger:hilt-android:2.51"
6967
kapt "com.google.dagger:hilt-compiler:2.51"
7068
69+
// room
70+
kapt "androidx.room:room-compiler:2.6.1"
7171
}
7272
7373
```
7474

7575
> `kapt`适用于kotlin项目,如果你的项目使用的java,请使用`annotationProcessor` 替代 `kapt`
7676
77-
## 版本特别说明
77+
## 使用
78+
79+
### 版本特别说明
7880

79-
* 3.x版本已统一使用`kotlin`并进行了重构;之前2.x版本内部使用的`LiveData`相关代码已全部移除,3.x版本已全部改用kotlin独有的`Flow`进行实现。
81+
* 3.x版本统一改为使用`kotlin`并进行了重构;之前2.x版本内部使用的`LiveData`相关代码已全部移除,3.x版本已全部改用kotlin独有的`Flow`进行实现。
8082

81-
* 3.x相比较于2.x版本,更为精简,可定制性更高。(如果需要在`Compose`中进行使用,只需加上`Compose`的UI相关依赖,稍微封装下即可)
83+
* 3.x相比较于2.x版本更为精简,可定制性更高。(如果需要在`Compose`中进行使用,只需加上`Compose`的UI相关依赖,稍微封装下即可)
8284

8385
> 建议在新项目中使用;如果你之前使用的是2.x旧版本,请谨慎升级。
8486
@@ -88,8 +90,6 @@ dependencies{
8890

8991
> 从分割线此处开始,以下全部为3.x版本相关说明
9092
91-
## 使用
92-
9393
### 集成步骤代码示例 (完整示例,可直接查看[app](app)
9494

9595
**Step.1** 启用ViewDataBinding,在你项目中的build.gradle的android{}中添加配置:
@@ -256,7 +256,7 @@ class YourFragment: BaseFragment() {
256256
>
257257
>> 特殊场景:对于支持多个 BaseUrl 且支持动态可变的。
258258
>>> 选择:这个场景的选择,主要涉及到另外的方法,请查看 {@link RetrofitHelper#putDomain(String, String)} 和 {@link RetrofitHelper#putDomain(String, HttpUrl)}相关详情
259-
>
259+
260260

261261
更多使用详情,请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jitpack.io/com/github/jenly1314/MVVMFrame/latest/javadoc/)
262262

0 commit comments

Comments
 (0)