init

README.md

@@ -1,2 +1,19 @@
-# pmpw
-Poor Man's Proxmox Watchdog
+# Poor Man's Proxmox Watchdog
+
+A bash script working as a helthcheck for a VM. 
+
+Takes in a single argument in form of VMID.
+
+## Requirements
+Copy/clone code into your directory 
+
+Add exec permission on watchdog.sh
+
+`chmod u+x /path/to/watchdog.sh`
+
+## Examples
+
+`./watchdog.sh <REPLACE_WITH_VMID>` 
+
+`./watchdog.sh 100` 
+