From 6cea81136a39e9dc6710560688bf310840594a2d Mon Sep 17 00:00:00 2001 From: Kristian Knarvik Date: Sat, 22 Aug 2020 14:58:39 +0200 Subject: [PATCH] Updates README with usage information --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27f90c4..733165e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # Jar-Updater -A simple cli program used to replace a program's .jar file with another. \ No newline at end of file +A simple cli program used to replace a program's .jar file with another. + +## Usage +The software must be given one argument which is the download URL for the new file. +The second argument (optional) is the program to be run after the new file has been downloaded (usually the program calling this software). +The third argument is the new file name of the downloaded file. This is used when the file name in the URL might change. +The fourth argument is the amount of seconds to wait before starting the download. This gives the calling software time to exit, making its executable readable. + +The software is limited to downloading .jar files from knarcraft.net, but can be extended by replacing the URL validator. \ No newline at end of file