Update README.md

README.md

@@ -12,104 +12,150 @@ short_description: This agent simulates a full-service recruitment team .
 license: mit
 ---
 
-# 💼 AI Recruitment Agent Team
+# AI Recruitment Agent
 
-A Streamlit application that simulates a full-service recruitment team using multiple AI agents to automate and streamline the hiring process. Each agent represents a different recruitment specialist role - from resume analysis and candidate evaluation to interview scheduling and communication - working together to provide comprehensive hiring solutions. The system combines the expertise of technical recruiters, HR coordinators, and scheduling specialists into a cohesive automated workflow.
+A Streamlit-based application designed to simulate a full-service recruitment team through a suite of collaborative AI agents. These agents specialize in various stages of the hiring process—from resume screening and candidate evaluation to professional communication and interview coordination—working in unison to automate and optimize recruitment workflows.
 
-## Features
+---
+
+## 🚀 Key Features
 
-#### Specialized AI Agents
+### 🤖 Specialized AI Agents
 
-- Technical Recruiter Agent: Analyzes resumes and evaluates technical skills
-- Communication Agent: Handles professional email correspondence
-- Scheduling Coordinator Agent: Manages interview scheduling and coordination
-- Each agent has specific expertise and collaborates for comprehensive recruitment
+* **Technical Recruiter Agent**: Assesses resumes and evaluates technical competencies.
+* **Communication Agent**: Manages professional candidate correspondence via email.
+* **Scheduling Agent**: Coordinates interview scheduling across time zones.
+* All agents operate collaboratively to deliver a holistic recruitment experience.
 
+### 🔄 End-to-End Automation
 
-#### End-to-End Recruitment Process
-- Automated resume screening and analysis
-- Role-specific technical evaluation
-- Professional candidate communication
-- Automated interview scheduling
-- Integrated feedback system
+* Intelligent resume screening and analysis.
+* Tailored technical skill evaluation for each role.
+* Automated and professional email communication.
+* Smart interview scheduling with calendar integration.
+* Feedback and status updates for both recruiters and candidates.
 
-## Important Things to do before running the application
+---
 
-- Create/Use a new Gmail account for the recruiter
-- Enable 2-Step Verification and generate an App Password for the Gmail account
-- The App Password is a 16 digit code (use without spaces) that should be generated here - [Google App Password](https://support.google.com/accounts/answer/185833?hl=en) Please go through the steps to generate the password - it will of the format - 'afec wejf awoj fwrv' (remove the spaces and enter it in the streamlit app) 
-- Create/ Use a Zoom account and go to the Zoom App Marketplace to get the API credentials :
-[Zoom Marketplace](https://marketplace.zoom.us)
-- Go to Developer Dashboard and create a new app - Select Server to Server OAuth and get the credentials, You see 3 credentials - Client ID, Client Secret and Account ID
-- After that, you need to add a few scopes to the app - so that the zoom link of the candidate is sent and created through the mail. 
-- The Scopes are meeting:write:invite_links:admin, meeting:write:meeting:admin, meeting:write:meeting:master, meeting:write:invite_links:master, meeting:write:open_app:admin, user:read:email:admin, user:read:list_users:admin, billing:read:user_entitlement:admin, dashboard:read:list_meeting_participants:admin [last 3 are optional]
+## 🔧 Pre-Setup Instructions
 
-## How to Run
+Before launching the app, follow these essential setup steps:
 
-1. **Setup Environment**
-   ```bash
-   # Clone the repository
-    Clone this repo.
-    cd advanced_ai_agents/multi_agent_apps/agent_teams/ai_recruitment_agent_team
-    
-   # Install dependencies
-   pip install -r requirements.txt
-   ```
+### 📧 Gmail Configuration
 
-2. **Configure API Keys**
-   - OpenAI API key for GPT-4o access
-   - Zoom API credentials (Account ID, Client ID, Client Secret)
-   - Email App Password of Recruiter's Email
+1. Use a dedicated Gmail account for recruitment purposes.
+2. Enable 2-Step Verification on the account.
+3. Generate a 16-character App Password here: [Generate App Password](https://support.google.com/accounts/answer/185833?hl=en)
+   *(Use the code without spaces, e.g., `afecwejfawojfwrv`)*
 
-3. **Run the Application**
-   ```bash
-   streamlit run ai_recruitment_agent_team.py
+### 🎥 Zoom API Configuration
+
+1. Sign in to the [Zoom App Marketplace](https://marketplace.zoom.us).
+2. Navigate to the Developer Dashboard and create a new **Server-to-Server OAuth** app.
+3. Obtain the following credentials:
+
+   * Client ID
+   * Client Secret
+   * Account ID
+4. Add the following scopes:
+
+   ```
+   meeting:write:invite_links:admin
+   meeting:write:meeting:admin
+   meeting:write:meeting:master
+   meeting:write:invite_links:master
+   meeting:write:open_app:admin
+   user:read:email:admin
+   user:read:list_users:admin
+   billing:read:user_entitlement:admin  *(optional)*
+   dashboard:read:list_meeting_participants:admin  *(optional)*
    ```
 
-## System Components
+---
+
+## 🧪 Running the Application
+
+### 1. Environment Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/amanraghuvanshi/AI-Recruitment-Agent.git
+cd folder/ai_recruitment_agent_team
+
+# Install required packages
+pip install -r requirements.txt
+```
+
+### 2. Configure API Keys
+
+* OpenAI API Key (GPT-4o)
+* Zoom API Credentials (Client ID, Client Secret, Account ID)
+* Gmail App Password for recruiter email
+
+### 3. Launch the App
 
-- **Resume Analyzer Agent**
-  - Skills matching algorithm
-  - Experience verification
-  - Technical assessment
-  - Selection decision making
+```bash
+streamlit run ai_recruitment_agent_team.py
+```
 
-- **Email Communication Agent**
-  - Professional email drafting
-  - Automated notifications
-  - Feedback communication
-  - Follow-up management
+---
+
+## 🧠 System Architecture
+
+### 📄 Resume Analyzer Agent
+
+* Matches skills against job requirements
+* Verifies experience and background
+* Conducts preliminary technical evaluation
+* Aids in shortlisting candidates
+
+### 📧 Email Communication Agent
+
+* Crafts professional emails automatically
+* Sends notifications and updates
+* Handles follow-ups and feedback sharing
+
+### 📅 Interview Scheduler Agent
+
+* Creates and manages Zoom meeting links
+* Integrates with calendar APIs
+* Adjusts for time zones
+* Sends timely reminders
 
-- **Interview Scheduler Agent**
-  - Zoom meeting coordination
-  - Calendar management
-  - Timezone handling
-  - Reminder system
+---
+
+## 👤 Candidate-Centric Experience
+
+* Easy-to-use resume upload interface
+* Real-time status updates
+* Transparent communication process
+* Efficient and seamless interaction
+
+---
+
+## 🛠 Tech Stack
 
-- **Candidate Experience**
-  - Simple upload interface
-  - Real-time feedback
-  - Clear communication
-  - Streamlined process
+* **Framework**: Phidata
+* **LLM Model**: OpenAI GPT-4o
+* **APIs**: Zoom, Gmail (via EmailTools from Phidata)
+* **Resume Parsing**: PyPDF2
+* **Time Management**: pytz
+* **UI State**: Streamlit Session State
 
-## Technical Stack
+---
 
-- **Framework**: Phidata
-- **Model**: OpenAI GPT-4o
-- **Integration**: Zoom API, EmailTools Tool from Phidata
-- **PDF Processing**: PyPDF2
-- **Time Management**: pytz
-- **State Management**: Streamlit Session State
+## ⚠️ Disclaimer
 
+This application is intended to assist and enhance the recruitment process. Automated decisions should always be reviewed and validated by human recruiters before finalizing any hiring decision.
 
-## Disclaimer
+---
 
-This tool is designed to assist in the recruitment process but should not completely replace human judgment in hiring decisions. All automated decisions should be reviewed by human recruiters for final approval.
+## 🔮 Future Roadmap
 
-## Future Enhancements
+* Integration with Applicant Tracking Systems (ATS)
+* More advanced and customizable candidate scoring models
+* Support for video interviews and recording
+* Embedded technical and behavioral assessments
+* Multi-language support for global recruitment
 
-- Integration with ATS systems
-- Advanced candidate scoring
-- Video interview capabilities
-- Skills assessment integration
-- Multi-language support
+---