Update README.md

README.md

@@ -1,3 +1,40 @@
----
-license: mit
----
+---
+license: mit
+---
+This will open a GUI. From there:
+
+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 📘
+
+## 🤗 Hugging Face Repository
+
+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
+
+## 📝 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.
+
+## 🆘 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. 🙋‍♂️🙋‍♀️