diff --git a/README.MD b/README.MD index 5f8b4f7..e69b9eb 100644 --- a/README.MD +++ b/README.MD @@ -22,28 +22,28 @@ The **Weather AI Agent** is a smart weather assistant that provides real-time we ✅ Simple and elegant UI for ease of use ✅ Fast and efficient API calls ---- + ## ⚙️ Setup & Installation -### 1️⃣ Clone the Repository -```sh +### **1️⃣ Clone the Repository** +```bash git clone https://github.com/your-username/weather-ai-agent.git cd weather-ai-agent 2️⃣ Install Dependencies -Backend (FastAPI) -sh +🔹 Backend (FastAPI) +bash Copy Edit pip install -r requirements.txt -Frontend (Next.js) -sh +🔹 Frontend (Next.js) +bash Copy Edit cd frontend npm install 3️⃣ Configure API Keys -Create a .env file and add the following API keys: +Create a .env file in the project root and add the following API keys: env Copy @@ -53,36 +53,33 @@ GEO_API_KEY=your_geo_api_key WEATHER_API_KEY=your_weather_api_key OPENWEATHER_API_KEY=your_openweather_api_key 4️⃣ Run the Project -Start Backend (FastAPI) -sh +🚀 Start Backend (FastAPI) +bash Copy Edit uvicorn main:app --reload -Start Frontend (Next.js) -sh +🎨 Start Frontend (Next.js) +bash Copy Edit cd frontend npm run dev - -## 🏎️ Future Enhancements - -### **🔧 Backend Improvements** -- Enhance AI-based weather insights using machine learning. -- Integrate advanced weather models for better predictions. - -### **🗣️ Voice-Based Features** -- Add text-to-speech functionality for voice-based weather updates. -- Enable voice commands for hands-free weather queries. - -### **🌍 Multi-Location Support** -- Allow users to check weather for multiple locations simultaneously. -- Implement a favorites feature to save preferred locations. - -### **📱 Mobile App Version** -- Develop a mobile-friendly version of the application. -- Optimize UI/UX for seamless mobile experience. - - -##📜 License -This project is licensed under the MIT License. +``` + +🏎️ Future Enhancements +🔧 Backend Improvements +Enhance AI-based weather insights using machine learning. +Integrate advanced weather models for better predictions. +🗣️ Voice-Based Features +Add text-to-speech functionality for voice-based weather updates. +Enable voice commands for hands-free weather queries. +🌍 Multi-Location Support +Allow users to check weather for multiple locations simultaneously. +Implement a favorites feature to save preferred locations. +📱 Mobile App Version +Develop a mobile-friendly version of the application. +Optimize UI/UX for seamless mobile experience. +📜 License +This project is open-source and available under the MIT License. + +🚀 Happy Coding! 😊✨