From c252d141676bf85ffcef20126cb7a12f3f921b62 Mon Sep 17 00:00:00 2001
From: arglebargle <28817345+foundObjects@users.noreply.github.com>
Date: Mon, 15 Apr 2019 02:34:38 -0700
Subject: [PATCH] hello markdown my old friend

---
 README.md | 32 +++++++++++---------------------
 1 file changed, 11 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 1e8d3e9..c010288 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,19 @@
-pve-nag-buster (v01) https://github.com/foundObjects/pve-nag-buster
+pve-nag-buster  
 Persistent license nag removal for Proxmox VE 5.x
 
-This is a chunk of bash script to persistently remove the license nags from
-Proxmox VE.
+This is a chunk of bash script and some dpkg pre/post install hooks to persistently remove the license nags from Proxmox VE.
 
-The main script does two things: remove the unlicensed popup nag from the web gui
-and switches from the pve-enterprise repository to pve-no-subscription. This script
-is called every time a package updates the web gui javascript library or the
-pve-enterprise source list.
+The main script does two things: remove the unlicensed popup nag from the web gui and switches from the pve-enterprise repository to pve-no-subscription. This script is called every time a package updates the web gui or the
+pve-enterprise source list and will only run if packages containing those files are changed. There are no external dependencies beyond the base packages installed with PVE by default (awk, sed, grep, wget).
 
-There are no external dependencies beyond the base packages installed with PVE
-by default (awk, sed, grep, wget).
+The install script also contains a base64 encoded copy of pve-nag-buster.sh for use offline. I'd have just packed everything into install.sh by default but making everyone download, unxz and base64 decode a heredoc to look at what I'm doing seemed rude.
 
-The script will only run when packages modify the web gui or the enterprise source list
-
-Have a look inside install.sh for the inline code to unpack pve-nag-buster.sh offline
-without making an extra call out to github to download pve-nag-buster.sh. I'd have just
-packed everything into install.sh by default but making everyone download, unzip and
-base64 decode a heredoc to look at what I'm doing seemed rude.
-
-To use: 
-
-	wget https://raw.githubusercontent.com/foundObjects/pve-nag-buster/master/install.sh
-	# Read the script
-  chmod +x install.sh && ./install.sh
+To install: 
 
+```
+wget https://raw.githubusercontent.com/foundObjects/pve-nag-buster/master/install.sh
+# Read the script
+chmod +x install.sh && ./install.sh
+```
 
 Please get in touch if you find a way to improve this, otherwise enjoy!