pogmommy/batalert
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Format readme

Browse source
This commit is contained in:
Felix Ortmann 2020-12-26 17:07:55 +01:00
parent d90d6afeb4
commit 24aa158ac2
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,6 +1,14 @@
# Bat-Alert
<h1 align="center">
batalert
</h1>
<h4 align="center">
Send [D-Bus](https://www.freedesktop.org/wiki/Software/dbus/) notifications when the (Linux) host's battery runs low.
[![License][license-badge]][license-url]
</h4>
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