Removing unneeded modules + updating README.md

README.md

@@ -1,3 +1,40 @@
-# keyvault
+# keyvault (password manager)
 
-Secure CLI password manager written in Python.
+## About The Project
+
+This repository houses the code for keyvault, a fast, simple and secure CLI password manager written in Python. This program has the following features:
+
+* 256-bit AES encryption
+* SQLite3 database
+* TOTP support
+* Beautiful tables
+* Password input masking
+* Low process overhead
+
+My goal for this project was to make an easy-to-use password manager to learn about cybersecurity concepts like encryption, databases and Python in general.
+
+### Main Benefits
+
+#### Easy to operate
+
+Commands are incredibly simple even for those not used to CLI applications.
+
+#### Increased data integrity
+
+Instead of asymmetric encryption with public and private keys, all that needs to be backed up is the encrypted SQLite3 database.
+
+## Installation Guide
+
+### Linux/MacOS/Windows
+
+1. Open the Terminal (Linux/MacOS) or Command Prompt (Windows)
+
+2. Clone the git repository
+`git clone https://forge.sufyaan.me/TitanElectrons/keyvault.git`
+
+3. Change the current working directory to the 'keyvault' directory
+`cd keyvault/`
+
+4. Execute the Python script
+`python3 keyvault.py` (Linux/MacOS)
+`python keyvault.py` (Windows)

keyvault.py

@@ -9,9 +9,8 @@ try:
     from password_strength import PasswordStats
     from getpass import getpass as gp
     from secrets import token_urlsafe
-    from random import randint as rint, SystemRandom as sr
-    from atexit import register
-    from os import urandom, path, remove
+    from random import randint as rint
+    from os import path
 except ModuleNotFoundError:
     print("You have not installed the required modules. Follow these steps to do so:\n\n1. Open the terminal (Linux/MacOS) or command prompt (Windows).\n2. Navigate to this directory and then to the files directory.\n3. Type 'pip install -r dependencies.txt'.\n4. Restart the program.\n\nIf you have followed all the steps correctly, keyvault will work on the next start.")
     exit()