add README

This commit is contained in:
Aditya 2024-09-11 10:27:14 +05:30
parent 311fd173ec
commit 927be66a48
Signed by: aditya
SSH key fingerprint: SHA256:jL1IvWsjjlPtw6HvDIHfXfhO9IkIokNEyIfuFhSdoyU

35
README.md Normal file
View file

@ -0,0 +1,35 @@
# Monitor
Report website's status
## Usage
### Oneshot
```nix
nix run github:akr2002/monitor
```
### Persistent
Add the following to your `home.nix`
```nix
systemd.user.timers.monitor = {
Install.WantedBy = [ "timers.target" ];
Timer = {
OnBootSec = "1m";
OnUnitActiveSec = "1m";
Unit = "monitor.service";
};
};
systemd.user.services.monitor = {
Unit = {
Description = "A script to monitor websites.";
};
Install = {
WantedBy = [ "default.target" ];
};
Service = {
ExecStart = "${inputs.monitor.packages.${pkgs.system}.default}/bin/monitor";
};
};
```
Start:
```bash
systemctl --user start mointor.timer
```