Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kezong committed Feb 17, 2022
1 parent 9f1a8b0 commit 4a17836
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 35 deletions.
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,20 @@

- [中文文档](./README_CN.md)

The solution of merging aar works with [AGP][3] `3.0` and higher. (Tested in AGP 3.0 - 4.2.0, and Gradle 4.9 - 6.8)
The solution of merging aar works with [AGP][3] `3.0` and higher. (Tested in AGP 3.0 - 7.1.0, and Gradle 4.9 - 7.3)

## Getting Started

### Step 1: Add classpath
#### Add snippet below to your root build script file:
> JCenter services will be deprecated on May 1st 2021, if you are using the version in JCenter, it is recommended to rename the group name and switch to Maven Central. Like this:
'com.kezong:fat-aar:x.x.x' => 'com.github.kezong:fat-aar:x.x.x'
For Maven Central (The lastest release is available on [Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.kezong/fat-aar)):
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.github.kezong:fat-aar:1.3.6'
}
}
```
~~For JCenter (Deprecated, before 1.3.4):~~
```groovy
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.kezong:fat-aar:1.3.3'
classpath 'com.github.kezong:fat-aar:1.3.7'
}
}
```
Expand Down Expand Up @@ -140,12 +126,16 @@ See [anatomy of an aar file here][2].
| 1.3.+ | 3.0.0 - 4.1.0 | 4.9 - 6.8 |
| 1.3.4 - 1.3.5 | 3.0.0 - 4.1.0 | 4.9+ |
| 1.3.6 | 3.0.0 - 4.2.0 | 4.9+ |
| 1.3.7 | 3.0.0+ | 4.9+ |

The following link which version of Gradle is required for each version of the Android Gradle plugin. For the best performance, you should use the latest possible version of both Gradle and the plugin.

[Plugin version and Required Gradle version](https://developer.android.google.cn/studio/releases/gradle-plugin.html)

## Version Log
- [1.3.7](<https://github.com/kezong/fat-aar-android/releases/tag/v1.3.7>)
- Fix productFlavor detection in embed submodules [#348](https://github.com/kezong/fat-aar-android/issues/348)
- Support missingDimensionStrategy without productFlavors in current project. [#343](https://github.com/kezong/fat-aar-android/issues/343)
- [1.3.6](<https://github.com/kezong/fat-aar-android/releases/tag/v1.3.6>)
- Support AGP 4.2.0 [#290](https://github.com/kezong/fat-aar-android/issues/290) [#304](https://github.com/kezong/fat-aar-android/issues/304)
- Copy 'navigation' along with other R.$ classes. [#296](https://github.com/kezong/fat-aar-android/issues/296)
Expand Down
26 changes: 7 additions & 19 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,20 @@
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kezong/fat-aar-android/blob/master/LICENSE)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.kezong/fat-aar/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.kezong/fat-aar)

该插件提供了将library以及它依赖的library一起打包成一个完整aar的解决方案,支持AGP 3.0及以上。(目前测试的版本范围是AGP 3.0 - 4.2.0,Gradle 4.9 - 6.8
该插件提供了将library以及它依赖的library一起打包成一个完整aar的解决方案,支持AGP 3.0及以上。(目前测试的版本范围是AGP 3.0 - 7.1.0,Gradle 4.9 - 7.3

## 如何使用

#### 第一步: Apply classpath
##### 添加以下代码到你工程根目录下的`build.gradle`文件中:
> JCenter于2021.5.1不再提供服务, 如果你使用了JCenter中的版本,建议更改一下包名切换至Maven central, 比如:
'com.kezong:fat-aar:x.x.x' => 'com.github.kezong:fat-aar:x.x.x'
For Maven Central (The lastest release is available on [Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.kezong/fat-aar)):
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.github.kezong:fat-aar:1.3.6'
}
}
```
~~For JCenter (Deprecated, before 1.3.4):~~
```groovy
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.kezong:fat-aar:1.3.3'
classpath 'com.github.kezong:fat-aar:1.3.7'
}
}
```
Expand Down Expand Up @@ -152,13 +138,15 @@ AAR是Android提供的一种官方文件形式;
| 1.2.18+ | 3.0.0 - 4.1.0 | 4.9 - 6.8 |
| 1.3.+ | 3.0.0 - 4.1.0 | 4.9 - 6.8 |
| 1.3.4 | 3.0.0 - 4.1.0 | 4.9+ |
| 1.3.6 | 3.0.0 - 4.2.0 | 4.9+ |
| 1.3.7 | 3.0.0+ | 4.9+ |

[Gradle Plugin和所需求的Gradle版本官方文档](https://developer.android.google.cn/studio/releases/gradle-plugin.html)

## 更新日志
- [1.3.6](<https://github.com/kezong/fat-aar-android/releases/tag/v1.3.6>)
- 支持AGP 4.2.0 [#290](https://github.com/kezong/fat-aar-android/issues/290) [#304](https://github.com/kezong/fat-aar-android/issues/304)
- 处理'navigation'资源. [#296](https://github.com/kezong/fat-aar-android/issues/296)
- [1.3.7](<https://github.com/kezong/fat-aar-android/releases/tag/v1.3.7>)
- Fix productFlavor detection in embed submodules [#348](https://github.com/kezong/fat-aar-android/issues/348)
- Support missingDimensionStrategy without productFlavors in current project. [#343](https://github.com/kezong/fat-aar-android/issues/343)
- [1.3.5](<https://github.com/kezong/fat-aar-android/releases/tag/v1.3.5>)
- 修复在仅有jar工程时jar无法合并的问题. [#255](https://github.com/kezong/fat-aar-android/issues/255) [#288](https://github.com/kezong/fat-aar-android/issues/288)
- 修复在使用Gradle 6.0-6.8时的编译错误. [#277](https://github.com/kezong/fat-aar-android/issues/277)
Expand Down

0 comments on commit 4a17836

Please sign in to comment.