Update README.md

README.md

@@ -10,3 +10,37 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# Appointment Booking Bot for Virtual Doctor Appointments
+
+## Project Overview
+
+The Appointment Booking Bot is a comprehensive solution for managing virtual doctor appointments. It integrates with Google Calendar to automate appointment scheduling tasks, provides symptom analysis, and offers doctor recommendations based on user input. The system operates efficiently to improve patient experience and streamline healthcare provider operations.
+
+## Key Features
+
+- **Symptom Analysis:** Analyze user symptoms and suggest relevant doctors.
+- **Appointment Management:** Book, reschedule, delete, and check availability of appointments.
+- **Real-Time Updates:** Check doctor availability and book appointments instantly.
+- **Data Insights:** Provides actionable insights into appointment trends and patient preferences.
+
+## Tech Stack
+
+- **LangChain Framework:** Utilized for building the agent with multiple tools.
+- **Google Calendar API:** For managing appointment-related actions.
+- **Model:** Llama-3.1-70B-Versatile using Groq hardware for symptom analysis and health advice.
+- **Python:** Backend programming.
+- **Streamlit:** For user interface integration.
+- **MongoDB:** For secure data storage.
+
+## Files and Their Functions
+
+- **`functions.py`**: Contains information on all the tools and functions used in the project.
+- **`schema.py`**: Defines the input schema for all tools.
+- **`bot.py`**: Command-line interface (CLI) application for managing appointments and interacting with the bot.
+- **`app.py`**: Streamlit integration file that connects the model with the user interface for a seamless experience.
+- **`model.py`**: Contains the agent used for the system.
+- **`requirements.txt`**: Contains all the necessary libraries for development of this project.
+
+
+