path: root/README.md
diff options
Diffstat (limited to 'README.md')
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.