From f7ec14c3d0dd845c4765460bd6d99eca66923ba6 Mon Sep 17 00:00:00 2001 From: Husky <39809509+Huskydog9988@users.noreply.github.com> Date: Fri, 9 Jun 2023 13:37:33 -0400 Subject: [PATCH] Update readme to be more beginner friendly --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2b62e95..a0a7872 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,30 @@ The fractureiser malware once you run it, infects any jar it is able to find. Th ## Usage -``` -java -jar scanner.jar <# of threads> + +Most of the time you will only need to double click the jar file to run it, and it will launch with a gui. However, if you want to run it in the terminal, and still have the gui, you can run it with the following command: + +```bash +# Replace jarscanner-VERSION-HERE.jar with the name of the jar file you downloaded from our releases page. +# The file name will be something like jarscanner-1.0.0.jar or jarscanner-1.1-SNAPSHOT.jar +java -jar jarscanner-VERSION-HERE.jar ``` -## Example +## Advanced Usage +Usage Docs: +``` +java -jar jarscanner-1.1-SNAPSHOT.jar <# of threads> +``` + +Examples: ```bash # Scan your entire Windows system with 4 threads -java -jar scanner.jar 4 C:\ +java -jar jarscanner-1.1-SNAPSHOT.jar 4 C:\ # Scan your entire Linux system with 4 threads -java -jar scanner.jar 4 / +java -jar jarscanner-1.1-SNAPSHOT.jar 4 / + +# Scan you entire Windows system with 4 threads, and print out errors when a jar file fails to open +java -jar jarscanner-1.1-SNAPSHOT.jar 4 C:\ true ```