From e30762ced6c84f30469fd4dccfd776939c7d4cf9 Mon Sep 17 00:00:00 2001
From: Average Blank <hussainkhorakiwala45@outlook.com>
Date: Fri, 17 May 2024 00:41:16 +0530
Subject: [PATCH] Beatifying the readme file.

---
 README.md        | 64 +++++++++++++++++++++++++++++++++++++++++++-----
 Requirements.txt |  5 ----
 main.py          |  2 --
 3 files changed, 58 insertions(+), 13 deletions(-)
 delete mode 100644 Requirements.txt

diff --git a/README.md b/README.md
index 2f7cd7a..58eefec 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,58 @@
-# Requirements
-- Python
-- There are certain requirements. To install the required libraries, run:
-```
-python3 -m pip install -r requirements.txt
-```
+# Password Manager
+
+## About the Project
+The Password Manager is a secure and efficient solution for storing and managing your passwords using SQLite3. This project is designed to help users keep track of their passwords in a safe and encrypted manner, providing a user-friendly interface for easy password retrieval and management. Developed with Python and various powerful libraries, this system ensures high security and ease of use for managing sensitive information.
+
+## Purpose
+The purpose of the Password Manager project is to offer a practical tool for managing passwords securely, leveraging SQLite3 for robust database operations and the `cryptography` library for encryption. By using this system, users can experience secure password storage, quick retrieval, and the convenience of a user-friendly command-line interface built with `questionary` and `rich`. This project aims to provide a valuable utility for everyday password management while showcasing the application of encryption and database management techniques.
+
+## Preview
+-- To Be Added --
+
+## Setting Up Locally
+
+### Prerequisites
+Make sure you have Python installed on your system.
+
+- **[Python](https://www.python.org/downloads/)**: Download and install Python.
+
+### Installation Steps
+
+1. **Clone the repository**
+    ```bash
+    git clone https://github.com/AverageBlank/PasswordManager.git
+    cd PasswordManager
+    ```
+
+2. **Create a virtual environment**
+    ```bash
+    python -m venv venv
+    venv\Scripts\activate  # On bash use `source venv/bin/activate`
+    ```
+
+3. **Install the required libraries**
+    ```bash
+    pip install pyperclip pwinput cryptography rich questionary
+    ```
+
+4. **Run the application**
+    ```bash
+    python main.py
+    ```
+
+## Languages Used
+- **Python**: The main programming language used for the backend.
+- **SQL**: Language used for interacting with the SQLite3 database.
+
+## Libraries Used
+- **String**: Implements common string operations.
+- **OS**: Allows interaction with the operating system.
+- **random**: Implements pseudo-random number generators for various distributions.
+- **time**: Provides various time-related functions.
+- **sqlite3**: A built-in Python library for interacting with SQLite databases.
+- **pyperclip**: A cross-platform Python module for clipboard functions.
+- **pwinput**: A Python library for secure password input.
+- **re**: Provides regular expression matching operations.
+- **cryptography (fernet)**: A cryptography library for secure communications. Fernet is used for encryption and decryption.
+- **questionary**: A Python library for building interactive command-line applications.
+- **rich**: A Python library for rich text and beautiful formatting in the terminal.
diff --git a/Requirements.txt b/Requirements.txt
deleted file mode 100644
index fbb7101..0000000
--- a/Requirements.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-pyperclip           # * Used for copying strings to clipboard.
-pwinput             # * Used for hiding what is typed.
-cryptography        # * Used for encrypting passwords.
-rich                # * User for better CLI.
-questionary         # * Used for better CLI.
diff --git a/main.py b/main.py
index a660376..75404a3 100644
--- a/main.py
+++ b/main.py
@@ -455,7 +455,6 @@ def CopyEntry(t):
     except InvalidToken:
         sleep(1)
         print("Please enter the correct encryption key.")
-        sleep(0.5)
         cont().ask()
 
 
@@ -503,4 +502,3 @@ def PrintOptions():
 
     #####* Printing Options #####
     PrintOptions()
-