README.md in danger-apkstats-0.0.2 vs README.md in danger-apkstats-0.1.0
- old
+ new
@@ -1,5 +1,7 @@
+[](https://travis-ci.com/jmatsu/danger-apkstats) [](https://badge.fury.io/rb/danger-apkstats)
+
# danger-apkstats
A description of danger-apkstats.
## Installation
@@ -12,15 +14,34 @@
your `Dangerfile` under the `apkstats` namespace.
# Sample
```
-apkstats.command_type=:apk_analyzer # required
-apkstats.apk_filepath='app-debug.apk' # required
+apkstats.apk_filepath='app-debug.apk' # required.
apkstats.compare_with('app-other.apk', do_report: true)
-apkstats.filesize
-apkstats.downloadsize
+apkstats.file_size #=> Fixnum
+apkstats.download_size #=> Fixnum
+apkstats.required_features #=> Array<String> | Nil
+apkstats.non_required_features #=> Array<String> | Nil
+apkstats.permissions #=> Array<String> | Nil
+apkstats.min_sdk #=> String | Nil
+apkstats.target_sdk #=> String | Nils
```
+
+## Compare apk files
+
+The report will be like below.
+
+### Apk comparision results
+
+Property | Summary
+:--- | :---
+New File Size | 1621248 Bytes. (1.55 MB
+File Size Change | -13352 Bytes. (-13.04 KB)
+Download Size Change | +41141 Bytes. (+40.18 KB)
+Removed Required Features | - android.hardware.camera
+Removed Non-required Features | - android.hardware.camera.front (not-required)
+Removed Permissions | - android.permission.INTERNET<br>- android.permission.CAMERA
## Development
1. Clone this repo
2. Run `bundle install` to setup dependencies.