aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTomasz Kramkowski <tk@the-tk.com>2020-12-30 22:27:42 +0000
committerTomasz Kramkowski <tk@the-tk.com>2020-12-30 22:27:42 +0000
commit3c1698a8d99e8fd74955b8e4456a3b7c114a7e7f (patch)
tree0b4bc1a4599c3a3a94a2e8ff0efcc890e42c7e21 /README.md
parentc560f0f02ddf51a3ce38a945b48ecf49a138e38d (diff)
downloadbattd-master.tar.gz
battd-master.tar.xz
battd-master.zip
Expand readmeHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6acba52..ae8d1fe 100644
--- a/README.md
+++ b/README.md
@@ -29,3 +29,8 @@ Configure `conf` appropriately. This should contain three functions:
: Called when the battery status has transitioned from a successful to a
failing return.
+An example `conf` is included and installed alongside the run script. An
+included `battcheck` awk script takes two optional arguments and a path to the
+uevent file of a battery to determine if the battery capacity and estimated
+run-time meet the specified criteria. Multiple invocations of `battcheck` can be
+used to handle more complex logic involving multiple batteries.