README doesn't exist about battery-historian

[meteormatt]

TO USE: (see also usage() below)
adb shell dumpsys batterystats --enable full-wake-history (post-KitKat only)
adb shell dumpsys batterystats --reset
optionally start monsoon/power monitor logging:
if device/host clocks are not synced, run historian.py -v
cts/tools/utils/monsoon.py --serialno 2294 --hz 1 --samples 100000 \
-timestamp | tee monsoon.out
...let device run a while...
stop monsoon.py
adb bugreport > bugreport.txt
./historian.py -p monsoon.out bugreport.txt

https://github.com/google/battery-historian/blob/master/historian.py

[seato]

@meteormatt I understand that the usage exists in the source code comment and in usage(). The point of a README lets people have an idea of a library's purpose (not in the source code) and usage examples (this exists in the source) without digging into the source code or library. Don't you agree?

[meteormatt]

@seato Yes. I agree.

[vbauer]

👍

[paulirish]

Screenshot for the readme:

[MarcusWolschon]

There is one VERY important information that isn't conveyed to the developer:
What minimum Android version is required for the mentioned
" # adb shell dumpsys batterystats"

Everyone analysing battery performance on phones older then this, shouldn't even have to spend time trying to figure out if this project is actually a usable tool for him/her.
(https://developer.android.com/about/versions/android-5.0.html
aparently it's not supported on Android 4.0.4 and 4.1 so if your phone will never get a 5.0 update, you're out of luck.)

[paulirish]

Colt’s Super Unofficial Guide to Getting started with Battery Historian

[tjohns]

This was fixed with the Battery Historian 2.0 release at Google I/O.