Updates readme to account for changes in behavior
All checks were successful
KnarCraft/Jar-Updater/pipeline/head This commit looks good

This commit is contained in:
Kristian Knarvik 2020-08-29 12:17:09 +02:00
parent 4cb0be6a8c
commit fdc5eb1db8

View File

@ -1,10 +1,11 @@
# Jar-Updater
A simple cli program used to replace a program's .jar file with another.
A simple cli program used to replace a program's .jar file with another. This program is necessary because a .jar cannot
replace itself because it's locked while it's running (on some operating systems).
## 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 second argument (optional) is whether to run the downloaded file if the download was successful.
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.