update readme with an example and info on acpid

This commit is contained in:
2025-09-29 23:38:01 -04:00
parent 323cef6e35
commit c89bcb4d68
2 changed files with 7 additions and 1 deletions

View File

@@ -3,12 +3,18 @@ My custom event handler for battery related things. Here's a brief rundown of
all the features:
When the percentage gets below a specified percentage it will blink the
specified led at any rate defined by the config file.
specified led at any rate defined by the config file. Example:
![blink.mp4](./examples/blink.mp4 "blink.mp4")
If the system is plugged in and a wayland session is running then the event
handler will place an idle inhibitor on the session to keep the computer from
going to sleep. The inhibitor is removed when the system is unplugged.
> [!WARNING]
> event-handler relies on [acpid](https://wiki.archlinux.org/title/Acpid) to
> monitor battery events ensure you have it installed and running before using
> event-handler
## Default Config
```toml
[battery]

BIN
examples/blink.mp4 Normal file

Binary file not shown.