diff --git a/README.md b/README.md index bf0d9e0..8c4c315 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ +Alerts you if your battery is overcharged or discharged to extend its performance and health. + +Cross-platform compatibility: +- Windows. +- MacOS. +- Linux. +- FreeBSD. + # Install ```bash +git clone git@github.com:tanrax/alert-battery-to-maintain-health.git +cd alert-battery-to-maintain-health poetry install ``` @@ -14,4 +24,4 @@ poetry run python3 alert_battery_to_maintain_health/__init__.py ```bash poetry run python3 alert_battery_to_maintain_health/__init__.py -``` \ No newline at end of file +```