Update README.md
This commit is contained in:
parent
6b1e995445
commit
9b47dd7f4b
1 changed files with 36 additions and 1 deletions
37
README.md
37
README.md
|
@ -1,3 +1,38 @@
|
||||||
# utility-charge-notifier
|
# utility-charge-notifier
|
||||||
|
|
||||||
Utility script to poll battery state and show a message outside configured thresholds.
|
Utility script to poll battery state and show a message outside configured thresholds.
|
||||||
|
|
||||||
|
The script is configurable and uses an interval and lower/upper threshold for battery.
|
||||||
|
|
||||||
|
The script utilizes libnotify to send a system message when outside the limits - thus ensuring you don't forget to plug or unplug your laptop charger.
|
||||||
|
|
||||||
|
## Script
|
||||||
|
|
||||||
|
Create the local bin folder
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir ~/.local/bin
|
||||||
|
```
|
||||||
|
|
||||||
|
Copy the main script to your local bin folder
|
||||||
|
|
||||||
|
```
|
||||||
|
touch ~/.local/bin/charge-notify.sh && chmod +x ~/.local/bin/charge-notify.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
The battery levels are example levels.
|
||||||
|
Edit the battery levels according to your system and preference.
|
||||||
|
|
||||||
|
## Run script as a user service
|
||||||
|
Create user service to to execute the script after startup
|
||||||
|
|
||||||
|
Create the folder ~/.config/systemd/user
|
||||||
|
```
|
||||||
|
mkdir ~/.config/systemd/user
|
||||||
|
```
|
||||||
|
Copy the service definition `charge-notifier.service` the new folder
|
||||||
|
|
||||||
|
```
|
||||||
|
systemctl --user enable --now charge-notifier.service
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue