README.md in danger-apkstats-0.2.0 vs README.md in danger-apkstats-0.3.0
- old
+ new
@@ -1,18 +1,24 @@
-[![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)
+[![jmatsu](https://circleci.com/gh/jmatsu/danger-apkstats.svg?style=shield)](https://circleci.com/gh/jmatsu/danger-apkstats) [![Gem Version](https://badge.fury.io/rb/danger-apkstats.svg)](https://badge.fury.io/rb/danger-apkstats)
# 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` or add `danger-apkstats` to your Gemfile.
-Also, you need to have ANDROID_HOME which indicates sdk location in your environment variables.
+Please specify the path of apkanalyzer in your Dangerfile.
+```ruby
+apkstats.apkanalyzer_path='/path/to/apkanalyzer'
+```
+
+`ANDROID_HOME` has been officially deprecated. `ANDROID_SDK_ROOT` is similar to `ANDROID_HOME` but differs actually. And also, the change indicated the possibility of further deprecations and/or breaking changes in the Android SDK structure.
+
## Usage
`apkstats` namespace is available under Dangerfile.
### Required preparation
@@ -59,5 +65,11 @@
1. Clone this repo
2. Run `bundle install` to setup dependencies.
3. Run `bundle exec rake spec` to run the tests.
4. Use `bundle exec guard` to automatically have tests run as you make changes.
5. Make your changes.
+
+### Supported ruby versions
+
+Support only versions which are in normal and/or security maintenance.
+
+ref: https://www.ruby-lang.org/en/downloads/branches/