diff --git a/README.md b/README.md index 9c7324f..e2ecc0e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -# Bat-Alert +

+ batalert +

+

+ +Send [D-Bus](https://www.freedesktop.org/wiki/Software/dbus/) notifications when the (Linux) host's battery runs low. + +[![License][license-badge]][license-url] + +

-An application to send [D-Bus](https://www.freedesktop.org/wiki/Software/dbus/) notifications when the (Linux) host's battery runs low. ## Prerequisites @@ -31,6 +39,13 @@ You can run `batalert` with default setting to send the first notification when batalert --uevent /sys/class/power_supply/BAT2/uevent ``` +## Building + +Build the app via `Cargo`: +``` +cargo build --release +``` - +[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg +[license-url]: https://github.com/0ortmann/batalert/blob/master/LICENSE \ No newline at end of file