From fdb5a0d74f57955809719d0bfe6ef7d7b3740eee Mon Sep 17 00:00:00 2001
From: ToBinio <tobias.frischmann1@gmail.com>
Date: Tue, 9 Dec 2025 12:12:49 +0100
Subject: [PATCH] add readme.md

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2c370a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Hydration Notifier
+
+A simple service that reminds you to drink water at regular intervals via notification.
+
+## Installation
+
+Install via Systemd
+
+1. Build and Install `hydration-notifier` using Cargo:
+
+```sh
+cargo install --path .
+```
+
+2. Create a systemd service file at `~/.config/systemd/user/hydration-notifier.service` with the following content:
+
+```ini
+[Unit]
+Description=Hydration Notifier Service
+After=network.target
+
+[Service]
+ExecStart=/home/<username>/.cargo/bin/hydration-notifier
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+3. Enable and start the service:
+
+```sh
+systemctl --user daemon-reload
+systemctl --user enable hydration-notifier.service
+systemctl --user start hydration-notifier.service
+```
+
+4. Verify the service status:
+
+```sh
+systemctl --user status hydration-notifier.service
+```
-- 
2.51.2