diff --git a/README.md b/README.md index 0c16d2e..4bc2685 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,31 @@ - [ ] Implement secure key exchange - [ ] Implement digital signatures (will replace the existing HMAC) + +## Description + +A project for COMP6453. + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) + +## Installation +Ensure you have Python 3.9 installed on your system. Then follow these steps: + 1. Clone the repository: + ```bash + git clone https://github.com/zhewenshen/applied-cryptography-project.git + ``` + 2. Navigate to the project directory: + ```bash + cd applied-cryptography-project + ``` + 3. Install the required dependencies: + ```bash + pip3 install -r requirements.txt + ``` +## Usage +For sample usage please refer to [`src/main.py`](src/main.py) + +