From 777aca0360c2c03377e36a28335d2bc8298dd925 Mon Sep 17 00:00:00 2001 From: Arkaprabha Chakraborty Date: Sun, 29 Jan 2023 23:54:19 +0530 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c53c04e..04c7f87 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,42 @@ ## 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 * 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 -* `./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 ` reads the input file, encrypts the data, and writes to the output file. +COMMAND: + -h, --help + Prints this help message -* `./rustcm-cli --decrypt ` reads the input file, decrypts the data, and writes to the output file. + -v, --version + Prints the version information + + -e, --encrypt + Runs the program in encryption mode + + -d, --decrypt + Runs the program in decryption mode +``` ## 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