From 2b3a18d06c9cc776ae3471df85e0b35cbdc97673 Mon Sep 17 00:00:00 2001 From: Vicky Rampin Date: Thu, 11 Nov 2021 23:21:05 -0500 Subject: [PATCH] add updated details to README --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a1c6996..5d97c64 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,18 @@ Author: Vicky Rampin **AES Encryption Implementation**: write a program to encrypt and decrypt a file using the AES algorithm. You can implement the functions you need or use the libraries. ## Installation -This script is made with Python 3.8 and uses the `argparse` and `pathlib` libraries. Ensure that you have [Python 3.8+](https://www.python.org/downloads/) installed in order to run this script correctly. +This script is made with Python 3.8 and uses the `argparse` and `pycryptodome` libraries. Ensure that you have [Python 3.8+](https://www.python.org/downloads/) and these libraries installed in order to run this script correctly. ## Usage First, clone this repository to your machine. Open the command line on your machine and navigate to where you cloned this repository. To get help using `cd`, use [this tutorial](https://swcarpentry.github.io/shell-novice/02-filedir/index.html). -Before running the script, you should know it expects two arguments: -1. `--file` : provide a path to the file that you want to decrypt -2. `modality`: either encrypt and decrypt, tells the script which activity you'd like to do +Before running the script, you should know it expects one argument: +1. `--file` or `-f` : provide a path to the file that you want to decrypt With this in mind, you can run it like so: ``` -$ python index.py --file=README.md encrypt +$ python index.py --file=README.md ``` -Or like this: - -``` -$ python index.py --file=/home/user/Desktop/secureFile.txt decrypt -``` +It will encrypt and decrypt the file, and print the contents. \ No newline at end of file