Update README.md

README.md

@@ -37,45 +37,57 @@ Ensure you have the following installed before running the project:
 - 🌐 Flask
 - 🔗 Requests
 - 🏗️ BeautifulSoup4 (bs4)
+- 🦄 Gunicorn (for production/deployment)
 
-You can install dependencies using:
+You can install dependencies locally using:
 ```sh
-pip install flask requests beautifulsoup4
+pip install -r requirements.txt
+
 ```
 
 ## Project Structure
+
 📂 **Project Directory:**
+
 ```
 /your_project_directory
 │── app.py               # 🏗️ Main Flask application
+│── Dockerfile           # 🐳 Docker configuration for Hugging Face
+│── requirements.txt     # 📦 Project dependencies
 │── templates/
 │   │── index.html       # 📄 Home page with form
 │   │── result.html      # 📄 Page to display scraped data
-│── static/              # 🎨 (Optional) CSS/JS files
 │── README.md            # 📖 Project Documentation
+
 ```
 
-## Usage
-🚀 **Run the Flask Application:**
+## Usage & Deployment (Hugging Face Spaces)
 
-Create start.sh file and write:
+This project is configured to easily deploy on **Hugging Face Spaces** using the Docker SDK.
 
-```sh
-python app.py
-```
+🚀 **Deploying to Hugging Face:**
+
+1. Create a new Space on [Hugging Face](https://huggingface.co/spaces).
+2. Set the **Space SDK** to **Docker** and choose the **Blank** template.
+3. Upload your project files (`app.py`, `Dockerfile`, `requirements.txt`, and the `templates` folder) to the Space.
+4. The Space will automatically build the container and start the app on port `7860` using `gunicorn`.
 
 🌍 **Access the Web App:**
-Open your browser and visit:
+Once the build is complete, your app will be live at your Hugging Face Space URL:
+
 ```
-http://yourprojectname.glitch.me/
+[https://yourusername-yourspacename.hf.space/](https://yourusername-yourspacename.hf.space/)
+
 ```
 
 📝 **Enter URL and Tag:**
+
 1. Provide a valid URL.
 2. Specify an HTML tag (e.g., `p`, `h1`, `div`).
 3. Click submit to fetch and display the data.
 
 ## Code
+
 ```python
 from flask import Flask, render_template, request  # Flask is used to create a web app
 import requests  # To send HTTP requests
@@ -112,23 +124,25 @@ def scrape():
 if __name__ == "__main__":
     app.run(debug=True)  # Debug mode is enabled to show errors in the console
 
-```
-
-![image](https://github.com/user-attachments/assets/1a81b045-6962-4d62-92b9-ea3260705df2)
 
+```
 
 ## Notes
+
 ⚠️ **Important Considerations:**
-- Works only with publicly accessible websites.
-- Some websites may block requests (**Use user-agent headers to avoid 403 errors**).
-- Handles missing input errors but does not handle all exceptions.
+
+* Works only with publicly accessible websites.
+* Some websites may block requests (**Use user-agent headers to avoid 403 errors**).
+* Handles missing input errors but does not handle all exceptions.
 
 ## Future Improvements
+
 ✨ **Potential Enhancements:**
-- 🔄 Add support for multiple tags.
-- 📜 Implement pagination for large data sets.
-- 💾 Store scraped data in a database.
+
+* 🔄 Add support for multiple tags.
+* 📜 Implement pagination for large data sets.
+* 💾 Store scraped data in a database.
 
 ---
-🎉 **Happy Coding! 🚀**
 
+🎉 **Happy Coding! 🚀**