From a79063fe5023fb21011dabffab7c8937b13726f9 Mon Sep 17 00:00:00 2001
From: Andrea <andrea@bruschetta.cc>
Date: Mon, 11 Nov 2024 14:34:49 +0100
Subject: [PATCH] Add README.md with project description and usage instructions

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a1f91b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# RSA Generator in Rust
+
+RSA Generator written in Rust for TPSIT
+
+## Libraries used
+
+```
+colog = "1.3.0" -> Better logging
+log = "0.4.22" -> Base logging library
+num-bigint = { version = "0.4.6", features = ["rand"] } -> BigInt type + BigInt Random Generator
+num-traits = "0.2.19" -> Used for conversions
+num-primes = "0.3" -> Library used for generating prime numbers
+rand = "0.8" -> Random base library
+```
+
+## Usage
+1. Clone repo
+2. Either use `cargo run` or `cargo build`
+3. Run the code
+4. Cheers!
\ No newline at end of file