Update README.md

README.md

@@ -1,40 +1,68 @@
 ---
 license: mit
 ---
-This will open a GUI. From there:
+# 📚 Quote Identifier
 
+A program that identifies quotes in text documents using a BERT-based model. 🤖
+
+## 🛠️ Requirements
+
+- Python 3.10 🐍
+- pip (Python package installer) 📦
+
+## 🚀 Installation
+
+1. Clone this repository:
+
+```
+git clone [your-repo-url]
+cd [your-repo-name]
+```
+
+2. Install the required packages:
+
+```
+pip install pandas torch transformers tqdm
+```
+
+💡 Note: If you have a CUDA-capable GPU, visit https://pytorch.org for the appropriate PyTorch installation command.
+
+## 🏃‍♂️ Usage
+
+Run the program with:
+
+```
+python quote_identifier.py
+```
+
+GUI Instructions:
 1. 📂 Click "Open Text File" to select your text file.
 2. 🔍 Click "Identify Quotes" to process the file.
 3. 🖥️ A new window will open showing the text with identified quotes highlighted.
 
 ## 📁 Included Files
 
-- `quote_identifier.py`: The main Python script 🐍
-- `quotation_identifer_model/`: Directory containing the pre-trained model 🧠
-  - `checkpoint-1000/`: The model checkpoint ✅
-- `sample_book.txt`: A sample text file to test the program 📘
+- quote_identifier.py: Main Python script 🐍
+- quotation_identifer_model/: Directory containing the pre-trained model 🧠
+  - checkpoint-1000/: Model checkpoint ✅
+- sample_book.txt: Sample text file for testing 📘
 
-## 🤗 Hugging Face Repository
+## 🤗 Hugging Face Repository Contents
 
-The Hugging Face repository for this project includes:
-
-1. 🧠 The pre-trained quote identification model
-2. 📘 A sample text file (`sample_book.txt`)
-3. 🐍 The `quote_identifier.py` script
-4. 📄 This README
+1. Pre-trained quote identification model 🧠
+2. sample_book.txt 📘
+3. quote_identifier.py script 🐍
+4. This README 📄
 
 ## 📝 Notes
 
-- The program uses a local model stored in `./quotation_identifer_model/checkpoint-1000/`. Ensure this directory is present.
-- The program will create a `BERT_infrence_quote_input.csv` file in the same directory when processing a text file.
-- 🌓 You can toggle between light and dark modes using the "Toggle Dark Mode" button.
+- Ensure the local model directory ./quotation_identifer_model/checkpoint-1000/ is present.
+- The program creates a BERT_infrence_quote_input.csv file when processing text.
+- 🌓 Use the "Toggle Dark Mode" button to switch between light and dark themes.
 
 ## 🆘 Troubleshooting
 
-If you encounter any issues:
-
-- 📦 Ensure all required packages are installed correctly.
-- 🗂️ Check that the model directory is present and contains the necessary files.
-- 🐍 Verify that you're using Python 3.10.
-
-For further assistance, please open an issue in the GitHub repository. 🙋‍♂️🙋‍♀️
+If you encounter issues:
+1. 📦 Verify all required packages are correctly installed.
+2. 🗂️ Check that the model directory is present with necessary files.
+3. 🐍 Confirm you're using Python 3.10.