-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor readme.md to update usage instructions and command line options
- Loading branch information
Showing
1 changed file
with
29 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,43 @@ | ||
# SquirrelZip File compressor/archiver CLI-tool | ||
# SquirrelZip File Compressor/Archiver CLI Tool | ||
|
||
Simple CLI-tool for compressing files. | ||
Simple CLI tool for compressing and decompressing files. | ||
|
||
## Usage | ||
Build | ||
```bash | ||
|
||
### Build | ||
|
||
./build | ||
``` | ||
|
||
Run | ||
```txt | ||
./sq -i <file1,file2> -o <outputDir> | ||
``` | ||
|
||
```txt | ||
-a Read all files in the provided directory | ||
-d File path to decompress (Only one file at once) | ||
-c File paths to compress (Space separated file paths) | ||
-o string | ||
Output directory for compressed files (Optional) | ||
-p string | ||
Password for encryption (Optional) | ||
-v Print version | ||
``` | ||
|
||
### Run | ||
|
||
./sq -c <file1,file2> -o <outputDir> | ||
|
||
-v Print version information | ||
-c Input files or directory to be compressed [strings] (Space separated) | ||
-o Output directory for compressed/decompressed files (Optional) | ||
-a Algorithm to use for compression (Optional) [string] | ||
-p Password for encryption (Optional) [string] | ||
-all Read all files in the provided directory (Optional) | ||
-d Input file to decompress [strings] (Space separated) | ||
-h Print help | ||
|
||
## Examples | ||
|
||
### Compress | ||
#### Compress without password: | ||
```txt | ||
./sq -c file.txt file2.txt | ||
``` | ||
|
||
#### Compress with password: | ||
```txt | ||
./sq -c file.txt file2.txt -p mySecurepass1234 | ||
``` | ||
#### Or compress the whole directory: | ||
```txt | ||
./sq -a folder | ||
``` | ||
#### To provide output path use `-o` flag: | ||
```txt | ||
./sq -c file.txt -o output/files | ||
``` | ||
### Decompress without password | ||
```txt | ||
./sq -d compressed.sq | ||
``` | ||
### Decompress with password | ||
```txt | ||
./sq -d compressed.sq -p mySecurepass1234 | ||
``` | ||
|
||
#### Or compress the whole directory: | ||
./sq -all folder | ||
|
||
#### To provide an output path use the `-o` flag: | ||
./sq -c file.txt -o output/files | ||
|
||
### Decompress without password: | ||
./sq -d compressed.sq | ||
|
||
### Decompress with password: | ||
./sq -d compressed.sq -p mySecurepass1234 |