Skip to content

Commit

Permalink
Merge pull request #6 from jmatsu/update_readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
jmatsu authored Jul 31, 2018
2 parents f70a00c + 13fada2 commit 3585483
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Build Status](https://travis-ci.com/jmatsu/danger-apkstats.svg?branch=master)](https://travis-ci.com/jmatsu/danger-apkstats) [![Gem Version](https://badge.fury.io/rb/danger-apkstats.svg)](https://badge.fury.io/rb/danger-apkstats)

# danger-apkstats

A description of danger-apkstats.
Expand All @@ -14,18 +16,32 @@ A description of danger-apkstats.
# Sample

```
apkstats.command_type=:apk_analyzer # required
apkstats.apk_filepath='app-debug.apk' # required. It would be a base apk.
apkstats.apk_filepath='app-debug.apk' # required.
apkstats.compare_with('app-other.apk', do_report: true)
apkstats.file_size #=> Integer
apkstats.download_size #=> Integer
apkstats.required_features #=> Array<String>
apkstats.non_required_features #=> Array<String>
apkstats.permissions #=> Array<String>
apkstats.min_sdk #=> String
apkstats.target_sdk #=> String
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
Expand Down

0 comments on commit 3585483

Please sign in to comment.