add instructions

d-513 · Dec 11, 2021 · 928be9e · 928be9e
1 parent b61daa0
commit 928be9e
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,4 +6,18 @@ Paper has made it very difficult to auto update servers, because they discourage
 But then you see, yesterday a log4j vunl in minecraft allowed RCE.  
 As long as you have a GOOD backup, IMO auto updates are fine.
 
-### Installation
+### Installation
+
+Download the correct binary from Releases and install it to your $PATH.
+
+### Running
+
+`./the-binary-file paper-project-name project-version`  
+
+### Examples  
+
+Download PaperMC 1.18.1  
+`./paper-autoupdater-linux-amd64 paper 1.18.1`  
+Download Velocity 3.1.1  
+`./paper-autoupdater-linux-amd64 velocity 3.1.1`
+