Skip to content

Commit 5f49c71

Browse files
committed
修改文档和图标
1 parent af77533 commit 5f49c71

File tree

10 files changed

+45
-28
lines changed

10 files changed

+45
-28
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@ TheRouter: *Android componentization solution*
33

44
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)
55
[![Language](https://img.shields.io/badge/Language-Kotlin-green)](https://kotlinlang.org/)
6-
[![Wiki](https://img.shields.io/badge/Wiki-open-green)](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki)
6+
[![Wiki](https://img.shields.io/badge/Wiki-open-green)](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki)
7+
8+
中文文档请见:[README_CN.md](https://github.com/HuolalaTech/hll-wp-therouter-android/blob/main/README_CN.md)
79

810
### A. Features
911

1012
TheRouter core functions have four functionalities:
1113

12-
* Page Navigation([Navigator](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator.md)
13-
* Cross-module dependency injection([ServiceProvider](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ServiceProvider.md)
14-
* Single module automatic initialization ([FlowTaskExecutor](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor.md)
15-
* Enable client apps to remotely load method dynamically ([ActionManager](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ActionManager.md))
14+
* Page Navigation([Navigator](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator)
15+
* Cross-module dependency injection([ServiceProvider](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ServiceProvider)
16+
* Single module automatic initialization ([FlowTaskExecutor](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor)
17+
* Enable client apps to remotely load method dynamically ([ActionManager](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ActionManager))
18+
19+
* Demo:
1620

17-
* Demo: [Demo gif](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/demo.gif)
21+
<img src="https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/demo.gif" width="50%" alt="demo gif" />
1822

1923
### B. Introduction
2024

@@ -40,7 +44,7 @@ implementation "cn.therouter:router:1.1.0"
4044

4145
#### B2. initialization library
4246

43-
The library contains the automatic initialization function inside,link to: [Single module automatic initialization](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor.md); therefore, there's no need for any initialization code. However, it is recommended that you set the `Debug` environment according to your business settings to view log information.
47+
The library contains the automatic initialization function inside,link to: [Single module automatic initialization](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor); therefore, there's no need for any initialization code. However, it is recommended that you set the `Debug` environment according to your business settings to view log information.
4448

4549
```
4650
@Override
@@ -65,7 +69,7 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
6569

6670
#### B4. page navigation
6771

68-
For the meaning of the annotation `@Route`, please check the documentation: [Page Navigation](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator.md)
72+
For the meaning of the annotation `@Route`, please check the documentation: [Page Navigation](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator)
6973

7074
```
7175
@Route(path = "http://therouter.com/home", action = "action://scheme.com",
@@ -150,10 +154,10 @@ TheRouter
150154

151155
### E. Change Log
152156

153-
link to Wiki:[CHANGELOG](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/CHANGELOG)
157+
link to Wiki:[CHANGELOG](https://github.com/HuolalaTech/hll-wp-therouter-android/releases)
154158

155159
### F. Author
156-
[HUOLALA mobile technology team](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/hll.png).
160+
<img src="https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/hll.png" width="40%" alt="HUOLALA mobile technology team" />
157161

158162
### G. LICENSE
159163

README_CN.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,26 @@ Android 动态路由框架:TheRouter
99

1010
TheRouter 核心功能具备四大能力:
1111

12-
* 页面导航跳转能力([Navigator](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator.md)) 页面跳转能力介绍
13-
* 跨模块依赖注入能力([ServiceProvider](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ServiceProvider.md))跨模块依赖注入
14-
* 单模块自动初始化能力 ([FlowTaskExecutor](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor.md))单模块自动初始化能力介绍
15-
* 动态化能力 ([ActionManager](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ActionManager.md)) 动态化能力支持
12+
* 页面导航跳转能力([Navigator](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator)) 页面跳转能力介绍
13+
* 跨模块依赖注入能力([ServiceProvider](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ServiceProvider))跨模块依赖注入
14+
* 单模块自动初始化能力 ([FlowTaskExecutor](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor))单模块自动初始化能力介绍
15+
* 动态化能力 ([ActionManager](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/ActionManager)) 动态化能力支持
1616

17-
* Demo: [Demo gif](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/demo.gif)
17+
* Demo:
18+
19+
<img src="https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/demo.gif" width="50%" alt="demo gif" />
1820

1921
### 二、使用介绍
2022

2123
**更多详细使用文档请查看项目 wiki**[Wiki](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki)
2224

23-
**框架介绍,可查看货拉拉移动技术分享的博客文章**
25+
**框架介绍,可查看货拉拉移动技术分享的博客文章**[https://juejin.cn/post/7139378777268125726](https://juejin.cn/post/7139378777268125726)
2426

2527
#### 2.1 Gradle 引入
2628

2729
|module|apt|router|plugin|
2830
|---|---|---|---|
29-
|version|[![apt](https://img.shields.io/badge/apt-1.1.0-green)]()|[![router](https://img.shields.io/badge/router-1.1.0-green)]()|[![plugin](https://img.shields.io/badge/plugin-1.1.0-green)]()|
31+
|version|[![apt](https://img.shields.io/badge/apt-1.1.0-green)](https://repo1.maven.org/maven2/cn/therouter/apt)|[![router](https://img.shields.io/badge/router-1.1.0-green)](https://repo1.maven.org/maven2/cn/therouter/router)|[![plugin](https://img.shields.io/badge/plugin-1.1.0-green)](https://repo1.maven.org/maven2/cn/therouter/plugin)|
3032

3133
```
3234
// 项目根目录 build.gradle 引入
@@ -42,7 +44,7 @@ implementation "cn.therouter:router:1.1.0"
4244

4345
#### 2.2 初始化
4446

45-
框架内部包含自动初始化功能,详见[单模块自动初始化能力](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor.md)
47+
框架内部包含自动初始化功能,详见[单模块自动初始化能力](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/FlowTaskExecutor)
4648
无需任何初始化代码。但推荐你根据业务设置否为`Debug`环境,用以查看日志信息。
4749
`Application.attachBaseContext()` 方法中尽可能早设置当前是否为`Debug`环境。
4850

@@ -68,7 +70,7 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
6870

6971
#### 2.4 页面跳转
7072

71-
关于注解`@Route`的参数含义,请查看文档:[页面导航跳转能力](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator.md)
73+
关于注解`@Route`的参数含义,请查看文档:[页面导航跳转能力](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/Navigator)
7274

7375
```
7476
@Route(path = "http://therouter.com/home", action = "action://scheme.com",
@@ -117,16 +119,16 @@ public class HomeActivity extends BaseActivity {
117119

118120
#### 3.1 迁移工具一键迁移
119121

120-
可使用迁移工具一键迁移:
122+
可使用迁移工具一键迁移(GitHub下载比较慢)
121123

122-
* Mac OS 迁移工具:[uploads/file/TheRouterTransfer-Mac.zip](uploads/file/TheRouterTransfer-Mac.zip)
123-
* Windows 迁移工具:[uploads/file/TheRouterTransfer-Windows.zip](uploads/file/TheRouterTransfer-Windows.zip)
124+
* Mac OS 迁移工具:[uploads/file/TheRouterTransfer-Mac.zip](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/file/TheRouterTransfer-Mac.zip)
125+
* Windows 迁移工具:[uploads/file/TheRouterTransfer-Windows.zip](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/file/TheRouterTransfer-Windows.zip)
124126

125127
如果项目中使用了`ARouter``IProvider.init()`方法,可能需要手动处理初始化逻辑。
126128

127129
如下图:
128130

129-
<img src="https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/TheRouterTransfer.png" width="640px" height="692px" />
131+
<img src="https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/TheRouterTransfer.png" width="40%" />
130132

131133
#### 3.2 其他路由框架
132134

@@ -192,11 +194,15 @@ TheRouter
192194

193195
### 五、Change Log
194196

195-
详见 Wiki:[CHANGELOG](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/CHANGELOG)
197+
详见 Wiki:[CHANGELOG](https://github.com/HuolalaTech/hll-wp-therouter-android/releases)
198+
199+
### 六、Author
200+
201+
<img src="https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/hll.png" width="40%" alt="HUOLALA mobile technology team" />
196202

197-
### 六、Author
198-
[HUOLALA mobile technology team](https://github.com/HuolalaTech/hll-wp-therouter-android/wiki/uploads/image/hll.png).
203+
加入 【TheRouter】 官方微信群:
204+
<img src="https://kymjs.com/therouter/wx/therouter.jpg" width="40%" alt="TheRouter官方微信群:https://kymjs.com/therouter/wx" />
199205

200206
### 七、开源协议
201207

202-
TheRouter is licensed under the Apache License 2.0: [LICENSE](https://github.com/HuolalaTech/hll-wp-therouter-android/blob/master/LICENSE).
208+
TheRouter is licensed under the Apache License 2.0: [LICENSE](https://github.com/HuolalaTech/hll-wp-therouter-android/blob/master/LICENSE).

app/src/main/res/layout/main.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,13 @@
8383
android:layout_height="wrap_content"
8484
android:text="其他辅助能力演示" />
8585

86+
<ImageView
87+
android:layout_width="wrap_content"
88+
android:layout_height="wrap_content"
89+
android:layout_gravity="center_horizontal"
90+
android:layout_marginTop="15dp"
91+
android:src="@mipmap/logo" />
92+
8693
<ImageView
8794
android:layout_width="wrap_content"
8895
android:layout_height="wrap_content"

app/src/main/res/mipmap-hdpi/ic_launcher.png

100755100644
1.73 KB
Loading

app/src/main/res/mipmap-mdpi/ic_launcher.png

100755100644
1023 Bytes
Loading

app/src/main/res/mipmap-xhdpi/ic_launcher.png

100755100644
2.04 KB
Loading

app/src/main/res/mipmap-xxhdpi/ic_launcher.png

100755100644
3.48 KB
Loading

app/src/main/res/mipmap-xxxhdpi/ic_launcher.png

100755100644
5.04 KB
Loading
30.9 KB
Loading

hll-wp-therouter-android.wiki

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Subproject commit 865eb3c887bb2d35ec73e44f692318357c6edd65
1+
Subproject commit 176d183aa36c07075add50f85b1df09ec4f154be

0 commit comments

Comments
 (0)