Skip to content

Commit 23c6259

Browse files
committed
Refactor readme.md to update usage instructions and command line options
1 parent 61ff8af commit 23c6259

File tree

1 file changed

+29
-41
lines changed

1 file changed

+29
-41
lines changed

readme.md

+29-41
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,43 @@
1-
# SquirrelZip File compressor/archiver CLI-tool
1+
# SquirrelZip File Compressor/Archiver CLI Tool
22

3-
Simple CLI-tool for compressing files.
3+
Simple CLI tool for compressing and decompressing files.
44

55
## Usage
6-
Build
7-
```bash
6+
7+
### Build
8+
89
./build
9-
```
10-
11-
Run
12-
```txt
13-
./sq -i <file1,file2> -o <outputDir>
14-
```
15-
16-
```txt
17-
-a Read all files in the provided directory
18-
-d File path to decompress (Only one file at once)
19-
-c File paths to compress (Space separated file paths)
20-
-o string
21-
Output directory for compressed files (Optional)
22-
-p string
23-
Password for encryption (Optional)
24-
-v Print version
25-
```
10+
11+
### Run
12+
13+
./sq -c <file1,file2> -o <outputDir>
14+
15+
-v Print version information
16+
-c Input files or directory to be compressed [strings] (Space separated)
17+
-o Output directory for compressed/decompressed files (Optional)
18+
-a Algorithm to use for compression (Optional) [string]
19+
-p Password for encryption (Optional) [string]
20+
-all Read all files in the provided directory (Optional)
21+
-d Input file to decompress [strings] (Space separated)
22+
-h Print help
23+
2624
## Examples
25+
2726
### Compress
2827
#### Compress without password:
29-
```txt
3028
./sq -c file.txt file2.txt
31-
```
29+
3230
#### Compress with password:
33-
```txt
3431
./sq -c file.txt file2.txt -p mySecurepass1234
35-
```
36-
#### Or compress the whole directory:
37-
```txt
38-
./sq -a folder
39-
```
40-
#### To provide output path use `-o` flag:
41-
```txt
42-
./sq -c file.txt -o output/files
43-
```
44-
### Decompress without password
45-
```txt
46-
./sq -d compressed.sq
47-
```
48-
### Decompress with password
49-
```txt
50-
./sq -d compressed.sq -p mySecurepass1234
51-
```
5232

33+
#### Or compress the whole directory:
34+
./sq -all folder
5335

36+
#### To provide an output path use the `-o` flag:
37+
./sq -c file.txt -o output/files
5438

39+
### Decompress without password:
40+
./sq -d compressed.sq
5541

42+
### Decompress with password:
43+
./sq -d compressed.sq -p mySecurepass1234

0 commit comments

Comments
 (0)