-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
28 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,28 +1,34 @@ | ||
| # kelcryptor | ||
|
|
||
|  | ||
|
|
||
| A commandline file encryption and decryption application, written in [Go](https://go.dev). | ||
|
|
||
| ## Features | ||
|
|
||
| - AES-256-GCM encryption | ||
| - No limit on file size to be encrypted | ||
| - Keeps track of the integrity of encrypted file | ||
| - Get alert if wrong password is used without having to wait for the entire file to be decrypted | ||
| - Pass multiple files at a go to be encrypted/decrypted | ||
| - Ignore and skip files with errors when encrypting/decrypting many files | ||
| - Keeps track of time taken to encrypt/decrypt file(s) | ||
| - Shows progress of encryption/decryption | ||
|
|
||
| ## Installation | ||
|
|
||
| Clone this repository and run `make install` at the repository root | ||
|
|
||
| > Installation via the go module system (e.g. `go install`, or `go get`) | ||
| > currently installs outdated versions of kelcryptor. Please use the method | ||
| > stated above. | ||
| ### Local build | ||
|
|
||
| Clone this repository and run `make` at the repository root | ||
| # kelcryptor | ||
|
|
||
|  | ||
|
|
||
| A commandline file encryption and decryption application, written in [Go](https://go.dev). | ||
|
|
||
| ## Features | ||
|
|
||
| - AES-256-GCM encryption | ||
| - No limit on file size to be encrypted | ||
| - Keeps track of the integrity of encrypted file | ||
| - Get alert if wrong password is used without having to wait for the entire file to be decrypted | ||
| - Pass multiple files at a go to be encrypted/decrypted | ||
| - Ignore and skip files with errors when encrypting/decrypting many files | ||
| - Keeps track of time taken to encrypt/decrypt file(s) | ||
| - Shows progress of encryption/decryption | ||
|
|
||
| ## Installation | ||
|
|
||
| Clone this repository and run `make install` at the repository root | ||
|
|
||
| > Installation via the go module system (e.g. `go install kelcryptor`, or `go get kelcryptor` | ||
| > ) currently installs outdated versions of kelcryptor. Please | ||
| > use the method stated above. | ||
| If on Windows and/or without Makefile Tools, run the following command instead: | ||
| `go install -ldflags="-s -w"` | ||
|
|
||
| ### Local build | ||
|
|
||
| Clone this repository and run `make` at the repository root | ||
|
|
||
| If on Windows and/or without Makefile Tools, run the following command instead: | ||
| `go build -ldflags="-s -w"` |