From a9eb7ce52f0b95e9cbcf202ebefe97c73e9f0ab7 Mon Sep 17 00:00:00 2001 From: Arkaprabha Chakraborty Date: Sat, 28 Jan 2023 19:30:20 +0530 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4f2ec61..c53c04e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Rust Simple Text Cipher Machine -### 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. -### Build +## Build -* Have Cargo (Rust-langs' package manager) installed. +* Install [Cargo](https://github.com/rust-lang/cargo) * `cargo build --release` to build. You will find the program binary in the `./target/release` directory. -### Usage +## Usage * `./rustcm-cli --help` prints the help message. @@ -20,14 +20,14 @@ It does precisely what the name indicates, i.e., encryption and decryption of fi * `./rustcm-cli --decrypt ` reads the input file, decrypts the data, and writes to the output file. -### 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. -### License +## License Distributed under the GPLv3 License. See `LICENSE` for more information. -### Contributors +## Contributors -* [ME](https://github.com/arkorty) +* [Arkaprabha Chakraborty](https://github.com/arkorty)