diff --git a/README.md b/README.md index 36352f4..b49d4a0 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,20 @@ snafflerish but rusty! Currently it just looks for some hardcoded keywords to determine if a file has sensitive infomation, but it works! # USAGE: +snaferrous [OPTIONS] + +Options: + -o, --outfile path to save output file Defaults to not saving output. + --threads number of threads to use, default to 10. + Note thre thread count will be doubled, one set for share finder tasks, and one set for file and infor finding tasks. + -t, --targets specific targets. should be comma separated. + -v, --verbose echo all found files to the console, regardless of keyword matching. (all files will still be saved to the log file) + -h, --help Print help (see more with '--help') + -V, --version Print version + +# Compiling: +`git clone https://github.com/Pyro57000/snaferrous.git` +`cd snafferous` +`cargo build --target x86_64-pc-windows-gnu --release` +then your .exe will be in the targets/x86_64-pc-windows-gnu/release folder! diff --git a/src/main.rs b/src/main.rs index bff3946..fee78f7 100644 --- a/src/main.rs +++ b/src/main.rs @@ -36,7 +36,7 @@ struct Args{ #[arg(short, long, help = "path to save output file Defaults to not saving output.")] outfile: Option, - #[arg(short, long, help = "number of threads to use, default to 10. \nNote thre thread count will be doubled, one set for share finder tasks, and one set for file and infor finding tasks.")] + #[arg(long, help = "number of threads to use, default to 10. \nNote thre thread count will be doubled, one set for share finder tasks, and one set for file and infor finding tasks.")] threads: Option, #[arg(short, long, help = "specific targets. should be comma separated.")]