README.md in danger-apkstats-0.1.0 vs README.md in danger-apkstats-0.1.1.pre.1
- old
+ new
@@ -1,38 +1,46 @@
[](https://travis-ci.com/jmatsu/danger-apkstats) [](https://badge.fury.io/rb/danger-apkstats)
# danger-apkstats
-A description of danger-apkstats.
+This is a plugin of [Danger](https://github.com/danger/danger) for Android projects.
+This allows you to get attributes of your application file (apk) and report a summary of comparison between two application files.
## Installation
- $ gem install danger-apkstats
+`gem install danger-apkstats`
+Also, you need to have ANDROID_HOME which indicates sdk location in your environment variables.
+
## Usage
- Methods and attributes from this plugin are available in
- your `Dangerfile` under the `apkstats` namespace.
+`apkstats` namespace is available under Dangerfile.
+
+### Required preparation
-# Sample
-
```
apkstats.apk_filepath='app-debug.apk' # required.
-apkstats.compare_with('app-other.apk', do_report: true)
+```
+
+### Show attributes
+
+```
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
+### Get a comparison report
-The report will be like below.
+```
+apkstats.compare_with(String, do_report: Boolean)
+```
-### Apk comparision results
+For example, the report will be like below.
Property | Summary
:--- | :---
New File Size | 1621248 Bytes. (1.55 MB
File Size Change | -13352 Bytes. (-13.04 KB)