git.lirion.de

Of git, get, and gud

aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a7585fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+## I'm Batman!
+
+It's a simple shell script that can do two things:
+1. Report the current battery charge and whether the battery is charging or not.
+2. Shutdown the machine if the charge is below 5%, the battery is discharging,
+ and the user is privileged to do so.
+
+Currently I'm including this in a cron file. This repository should soon host a
+systemd timer file as well.
+
+To-Dos:
+[ ] systemd timer file
+[ ] use [/var]/run instead of /tmp for the "are we rebooting"-file
+
+## Why?
+
+Because I can :) There are other mechanisms out there, but I started this
+script in unintended ignorance of these and now I finished it ;)