Update README.md

README.md

@@ -1,99 +1,76 @@
-# [Project Name] 🎯
+# Nirbhaya 🎯
 
 
 ## Basic Details
-### Team Name: [Name]
+### Team Name: CodeX
 
 
 ### Team Members
-- Member 1: [Name] - [College]
-- Member 2: [Name] - [College]
-- Member 3: [Name] - [College]
+- Member 1: Arathy T.M. - College of Engineering Munnar
+- Member 2: Hridya Raju George - College of Engineering Munnar
+- Member 3: Aparna S. - College of Engineering Munnar
 
 ### Hosted Project Link
 [mention your project hosted project link here]
 
 ### Project Description
-[2-3 lines about what your project does]
+This project is a web-based safety and emergency assistance system designed to help individuals, especially women, navigate safely and access emergency support when needed. The platform integrates features such as real-time location tracking, emergency alerts, a precautionary checklist, and live guardian assistance to enhance security and provide immediate response during critical situations.
 
 ### The Problem statement
-[What ridiculous problem are you solving?]
+Women face safety concerns daily, especially while traveling alone, commuting at night, or in unfamiliar locations. In emergencies, quick access to help, secure routes, and real-time tracking is often unavailable or inefficient. Traditional safety measures like phone calls to family or self-defense tools are not always practical in high-risk situations.
 
 ### The Solution
-[How are you solving it? Keep it fun!]
+We’re turning your phone into a personal safety superhero! 
+Imagine having a guardian angel, a smart navigator, and an emergency siren all packed into one easy-to-use web app. That’s exactly what we’re building—a smart safety companion that helps you stay safe and connected, no matter where you are.
 
 ## Technical Details
 ### Technologies/Components Used
 For Software:
-- [Languages used]
-- [Frameworks used]
-- [Libraries used]
-- [Tools used]
-
-For Hardware:
-- [List main components]
-- [List specifications]
-- [List tools required]
+- JavaScript, HTML, CSS, Python
+- React.js, React Router, Flask
+- Firebase - NoSQL
+- Git, GitHub, VS Code, Postman
 
 ### Implementation
 For Software:
 # Installation
-[commands]
+git clone <your-repository-url>
+cd <your-project-folder>
+cd frontend
+npm install
+cd backend
+pip install -r requirements.txt
 
 # Run
-[commands]
+cd backend
+python app.py  # Or flask run if using Flask CLI
+cd frontend
+npm start
 
 ### Project Documentation
 For Software:
 
 # Screenshots (Add at least 3)
-![Screenshot1](Add screenshot 1 here with proper name)
-*Add caption explaining what this shows*
-
-![Screenshot2](Add screenshot 2 here with proper name)
-*Add caption explaining what this shows*
-
-![Screenshot3](Add screenshot 3 here with proper name)
-*Add caption explaining what this shows*
-
-# Diagrams
-![Workflow](Add your workflow/architecture diagram here)
-*Add caption explaining your workflow*
-
-For Hardware:
-
-# Schematic & Circuit
-![Circuit](Add your circuit diagram here)
-*Add caption explaining connections*
-
-![Schematic](Add your schematic diagram here)
-*Add caption explaining the schematic*
-
-# Build Photos
-![Team](Add photo of your team here)
-
 
-![Components](Add photo of your components here)
-*List out all components shown*
+https://drive.google.com/file/d/1CZ1yE9b4pRmBywe_XH0FY6zmwHw8mHzt/view?usp=drive_link
+Home Page
 
-![Build](Add photos of build process here)
-*Explain the build steps*
+https://drive.google.com/file/d/1CV1jTP8aUA8_NQDPoA1L_pBHhrH2xzhv/view?usp=drive_link
+Find Safe Route Page
 
-![Final](Add photo of final product here)
-*Explain the final build*
+https://drive.google.com/file/d/1CcjLoIOmERm2AFXqffFNFYeNYXWxlzsu/view?usp=drive_link
+Emergency Checklist
 
 ### Project Demo
 # Video
-[Add your demo video link here]
-*Explain what the video demonstrates*
+https://drive.google.com/file/d/1CvB4DD4aAL9yxkbktqWH5wC0r6zG8QLw/view?usp=drive_link
+This video demo shows the workflow of our web app. When you login to the web app, you will be redirected to the home page. There you will be provided some buttons that help you to ensure your safety.
 
-# Additional Demos
-[Add any extra demo materials/links]
 
 ## Team Contributions
-- [Name 1]: [Specific contributions]
-- [Name 2]: [Specific contributions]
-- [Name 3]: [Specific contributions]
+- Arathy T.M.: Frontend development
+- Hridya Raju George: Backend Development
+- Aparna S: Idea, documentation and testing
 
 ---
 Made with ❤️ at TinkerHub