mirror of
https://github.com/arkorty/rustcm-cli.git
synced 2026-03-18 00:57:17 +00:00
Update README.md
This commit is contained in:
29
README.md
29
README.md
@@ -2,27 +2,42 @@
|
|||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
It does precisely what the name indicates, i.e., encryption and decryption of files using the ChaCha20-Poly1305 authenticated streaming cipher algorithm. The program is still in its alpha (incomplete) stage.
|
It does precisely what the name indicates, i.e., encryption and decryption of UTF-8 encoded files using the ChaCha20-Poly1305 authenticated streaming cipher algorithm. The program is still in its alpha (incomplete) stage, you might come across a lot of bugs.
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
* Install [Cargo](https://github.com/rust-lang/cargo)
|
* Install [Cargo](https://github.com/rust-lang/cargo)
|
||||||
|
|
||||||
* `cargo build --release` to build. You will find the program binary in the `./target/release` directory.
|
* `cargo build --release` to build
|
||||||
|
|
||||||
|
* The program binary will be in the `./target/release` directory
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
* `./rustcm-cli --help` prints the help message.
|
```
|
||||||
|
rustcm-cli 0.1.0-alpha
|
||||||
|
Rust Simple Text Cipher Machine
|
||||||
|
|
||||||
* `./rustcm-cli --version` prints the version information.
|
USAGE:
|
||||||
|
rustcm-cli [COMMAND]
|
||||||
|
|
||||||
* `./rustcm-cli --encrypt <input-path> <output-path>` reads the input file, encrypts the data, and writes to the output file.
|
COMMAND:
|
||||||
|
-h, --help
|
||||||
|
Prints this help message
|
||||||
|
|
||||||
* `./rustcm-cli --decrypt <input-path> <output-path>` reads the input file, decrypts the data, and writes to the output file.
|
-v, --version
|
||||||
|
Prints the version information
|
||||||
|
|
||||||
|
-e, --encrypt <input-path> <output-path>
|
||||||
|
Runs the program in encryption mode
|
||||||
|
|
||||||
|
-d, --decrypt <input-path> <output-path>
|
||||||
|
Runs the program in decryption mode
|
||||||
|
```
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
Do not use this for any high value information. I won't be held accountable for any damage caused to you by this program. Please use at your own discretion.
|
Do not use this for any high value information. I shall not be held accountable for any damage caused to you by this program. Please use at your own discretion.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user