From 3c1698a8d99e8fd74955b8e4456a3b7c114a7e7f Mon Sep 17 00:00:00 2001 From: Tomasz Kramkowski Date: Wed, 30 Dec 2020 22:27:42 +0000 Subject: Expand readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) 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. -- cgit v1.2.3-54-g00ecf