Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme to be more beginner friendly #49

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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> <path to scan> <optional: 'true' for failed jar file opening errors>

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> <path to scan> <optional: 'true' for failed jar file opening errors>
```

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
```