Update README.md

README.md

@@ -1,14 +1,58 @@
----
-title: Smart Search LLM
-emoji: 🦀
-colorFrom: blue
-colorTo: gray
-sdk: streamlit
-sdk_version: 1.39.0
-app_file: app.py
-pinned: false
-license: mit
-short_description: LLM based search tool for free courses on Analytics Vidhya
+# 📚 Analytics Vidhya Smart Search Tool
+
+This project uses a **Large Language Model (LLM)** to help users find the most relevant free courses on Analytics Vidhya’s platform. Powered by **Groq's LLM**, the tool intelligently processes user queries and ranks courses by relevance, ensuring an advanced and intuitive search experience.
+
+## 🌟 Key Features
+
+- **Smart LLM-Powered Search**: Queries are processed by Groq's LLM to deliver relevant courses based on user input.
+- **Real-time Course Data**: The app scrapes and updates data directly from Analytics Vidhya's free courses page.
+- **Ranked Recommendations**: Each course is scored for relevance, with only the most relevant results displayed.
+- **Streamlit UI**: Built with Streamlit for a clean and user-friendly interface.
+- **Deployed on Hugging Face**: Accessible via Hugging Face Spaces for easy use and sharing.
+
+## 🧠 How It Works
+
+1. **Web Scraping**: The tool scrapes course titles, images, and URLs from Analytics Vidhya.
+2. **LLM-Driven Search**: Groq's LLM analyzes the user query and ranks the courses based on relevance.
+3. **Results Display**: Top results are shown with course titles, images, and relevance scores.
+
+## 🚀 Technologies
+
+- **Python**: Backend processing.
+- **Streamlit**: UI framework.
+- **BeautifulSoup**: For web scraping.
+- **Groq LLM**: Powering smart search.
+- **Pandas**: Data management.
+- **Hugging Face Spaces**: Deployment.
+
+## 🛠️ How to Run
+
+1. Clone the repo:
+   ```bash
+   git clone https://huggingface.co/spaces/metechmohit/Smart_Search_LLM
+   cd /Smart_Search_LLM
+   ```
+
+2. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. Add your **Groq API key** to a `.env` file:
+   ```
+   GROQ_API_KEY=your-groq-api-key
+   ```
+
+4. Run the app:
+   ```bash
+   streamlit run streamlit_app.py
+   ```
+
+## 🌐 Deployed Version
+
+You can try the live version on Hugging Face Spaces:  
+[**Live Demo**](https://huggingface.co/spaces/metechmohit/Smart_Search_LLM)
+
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Developed by [@metechmohit](https://github.com/metechmohit).