diff --git a/README.md b/README.md index af4d79e..e007c77 100644 --- a/README.md +++ b/README.md @@ -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](./examples/blink.mp4 "blink") 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] diff --git a/examples/blink.mp4 b/examples/blink.mp4 new file mode 100644 index 0000000..7548e10 Binary files /dev/null and b/examples/blink.mp4 differ