arkorty/rustcm-cli
1
0
Fork 0
mirror of https://github.com/arkorty/rustcm-cli.git synced 2026-03-18 00:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arkaprabha Chakraborty
2023-01-28 19:30:20 +05:30
parent 715a8d2abd
commit a9eb7ce52f
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,16 +1,16 @@
# Rust Simple Text Cipher Machine # 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. 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. * `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. * `./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 <input-path> <output-path>` reads the input file, decrypts the data, and writes to the output file. * `./rustcm-cli --decrypt <input-path> <output-path>` 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. 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. Distributed under the GPLv3 License. See `LICENSE` for more information.
### Contributors ## Contributors
* [ME](https://github.com/arkorty) * [Arkaprabha Chakraborty](https://github.com/arkorty)