update docs for v1.1.0

Author: Manabu-GT

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## Version 1.1.0 *(2017-09-01)*
+
+* Android O support (Note: CpuUsageModule/CpuFreqModule will not work on Android O and above)
+* Add a CpuFreqModule to show current/max frequencies of all the cpu cores
+* Support Library 25.3.1 -> 26.0.1
+
 ## Version 1.0.1 *(2017-04-05)*
 
 * Use split v4 support library as dependencies for less size

README.md

@@ -23,25 +23,25 @@ so you just need to add the followings to your ***build.gradle*** file:
 
 ```groovy
 dependencies {
-  debugCompile 'com.ms-square:debugoverlay:1.0.1'
-  releaseCompile 'com.ms-square:debugoverlay-no-op:1.0.1'
-  testCompile 'com.ms-square:debugoverlay-no-op:1.0.1'
+  debugCompile 'com.ms-square:debugoverlay:1.1.0'
+  releaseCompile 'com.ms-square:debugoverlay-no-op:1.1.0'
+  testCompile 'com.ms-square:debugoverlay-no-op:1.1.0'
 }
 ```
 
-Please note that `com.ms-square:debugoverlay:1.0.1`  will add `android.permission.SYSTEM_ALERT_WINDOW`  to your app. 
+Please note that `com.ms-square:debugoverlay:1.1.0`  will add `android.permission.SYSTEM_ALERT_WINDOW`  to your app. 
 Threfore, you should avoid to use that dependency for your release build.
 
 FYI, the following table describes the total number of method/field references in this library's release aar.
 This data is acquired by using [Dexcount Gradle Plugin](https://github.com/KeepSafe/dexcount-gradle-plugin).
 
 | library  | methods  | fields |
 |:------------- |:-------------|:-------------|
-|com.ms-square:debugoverlay:1.0.1|515|227|
-|com.ms-square:debugoverlay-no-op:1.0.1|127|36|
+|com.ms-square:debugoverlay:1.1.0|565|249|
+|com.ms-square:debugoverlay-no-op:1.1.0|142|37|
 
 Due to the extensibility of this library, no-op version unfortunately has more than a few methods.
-If you want to eliminate such method count in your release build, consider having separate `Application` class only for your debug build which uses this library and just specify `debugCompile 'com.ms-square:debugoverlay:1.0.1'` in the dependencies section of build.gradle.
+If you want to eliminate such method count in your release build, consider having separate `Application` class only for your debug build which uses this library and just specify `debugCompile 'com.ms-square:debugoverlay:1.1.0'` in the dependencies section of build.gradle.
 
 Usage
 ------
@@ -62,7 +62,7 @@ public class ExampleApplication extends Application {
 ```
 It will show a debug overlay on system layer with the follwing three default modules just like the gif animation image displayed on this README.
 
-- [CpuUsageModule](#cpuusagemodule)
+- [CpuUsageModule](#cpuusagemodule) - will not be shown on Android O and above
 - [MemInfoModule](#meminfomodule)
 - [FpsModule](#fpsmodule)
 
@@ -125,6 +125,8 @@ Provided Modules
 `default`
 > Collects total and app cpu usage % by reading `/proc/stat` and `/proc/[myPid]/stat` respectively.
 
+Note: CpuUsageModule will be no-op on Android O and above. Please see this [issue](https://github.com/Manabu-GT/DebugOverlay-Android/issues/11) for why.
+
 #### MemInfoModule
 
 `default`
@@ -142,6 +144,12 @@ If low memory situation is detected by reading [lowMemory](https://developer.and
 `optional`
 > Collects logcat messages generated by your own app even on non-rooted devices.
 
+#### CpuFreqModule
+`optional`
+> Collects each cpu core's current and max frequency by reading `/sys/devices/system/cpu/cpu[num]/cpufreq/scaling_cur_freq` and `/sys/devices/system/cpu/cpu[num]/cpufreq/cpuinfo_max_freq` respectively.
+
+Note: CpuFreqModule will be no-op on Android O and above. Please see this [issue](https://github.com/Manabu-GT/DebugOverlay-Android/issues/11) for why.
+
 Customization
 ------
 
@@ -198,7 +206,7 @@ Example:
 module = new CpuUsageModule(new MyCpuViewModule());
 ```
 
-For **CpuUsage, MemInfo, and Fps modules**, you can pass your own layout resource id as long as it contains TextView as a direct child with id set to `debugoverlay_overlay_text` which is already defined in this library. This allows you to style the TextView used within those modules very easily without fully implementing new [ViewModule][5] by yourself.
+For **CpuUsage, CpuFreq, MemInfo, and Fps modules**, you can pass your own layout resource id as long as it contains TextView as a direct child with id set to `debugoverlay_overlay_text` which is already defined in this library. This allows you to style the TextView used within those modules very easily without fully implementing new [ViewModule][5] by yourself.
 
 ### Adding your own overlay module
 
@@ -254,7 +262,8 @@ Since a new custom module called `IPAddressModule` is created, let's actually sh
 ```java
 // inside Application's onCreate()
 new DebugOverlay.Builder(this)
-        .modules(new CpuUsageModule(),
+        .modules(new CpuFreqModule(),
+                 new CpuUsageModule(),
                  new MemInfoModule(this),
                  new FpsModule(),
                  new IPAddressModule(this))
@@ -264,7 +273,7 @@ new DebugOverlay.Builder(this)
 
 Now, the overlay successfully shows the newly added custom module at the bottom.
 
-<img src="art/overlay_with_custom_module_small.png" width="50%" alt="DebugOverlay Screen Capture">
+<img src="art/overlay_with_custom_module_and_cpufreq_small.png" width="50%" alt="DebugOverlay Screen Capture">
 
 Thanks for reading!