Skip to content
Merged
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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,30 +20,30 @@ hashing, and batch searches for multiple targets.

## Installation

Build from source with Cargo:
Install from crates.io:

```bash
cargo build --release
cargo install hash-hunter
```

## Usage

Search a directory for a SHA-256 hash (default):

```bash
cargo run -- --dir ./data --hash <hex-hash>
hash-hunter --dir ./data --hash <hex-hash>
```

Provide a file name to shortcut hashing when possible:

```bash
cargo run -- --dir ./data --hash <hex-hash> --name report.pdf
hash-hunter --dir ./data --hash <hex-hash> --name report.pdf
```

Use a different algorithm:

```bash
cargo run -- --dir ./data --algo sha3-256 --hash <hex-hash>
hash-hunter --dir ./data --algo sha3-256 --hash <hex-hash>
```

Batch mode (one target per line):
Expand All @@ -55,13 +55,13 @@ Batch mode (one target per line):
```

```bash
cargo run -- --dir ./data --algo sha256 --batch batch.txt
hash-hunter --dir ./data --algo sha256 --batch batch.txt
```

Write results to a text file:

```bash
cargo run -- --dir ./data --hash <hex-hash> --output results.txt
hash-hunter --dir ./data --hash <hex-hash> --output results.txt
```

## Output
Expand Down