Skip to content

Commit e6955c5

Browse files
committed
docs: update installation instructions in README.md
1 parent 09263b0 commit e6955c5

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,20 @@ CompressedCrack is a command-line tool that utilizes the brute-force method to c
1414

1515
## Requirements
1616

17-
- Python 3.x
18-
- `patoolib` library
17+
- Python >= 3.6
1918

20-
To install the required library, run the following command:
19+
## Installation
20+
21+
You can install CompressedCrack directly from pip using the following command:
2122

2223
```
23-
pip install patoolib
24+
pip install compressedcrack
2425
```
2526

2627
## Usage
2728

2829
```
29-
main.py [-h] [--min-length MIN_LENGTH] [--max-length MAX_LENGTH] [--verbose] file_path
30+
compressedcrack [-h] [--min-length MIN_LENGTH] [--max-length MAX_LENGTH] [--verbose] file_path
3031
3132
Crack password-protected archives using brute force.
3233
@@ -60,7 +61,7 @@ If no character types are selected, the script will use the combination of all d
6061
Crack a password-protected file `archive.zip` with a minimum password length of 3 characters, maximum password length of 5 characters, verbose output, and the custom character set is `abcdef12345`:
6162

6263
```
63-
python main.py --min-length 3 --max-length 5 --verbose archive.zip
64+
compressedcrack --min-length 3 --max-length 5 --verbose archive.zip
6465
```
6566

6667
![Example](./assets/example.gif)

0 commit comments

Comments
 (0)