Update README.md

README.md

@@ -11,3 +11,83 @@ license: mit
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# CV Tailor - AI Resume Optimizer
+
+🎯 **Transform your resume to match any job posting using AI!**
+
+Upload your PDF resume and provide a job URL to get an AI-tailored resume that highlights your most relevant skills and experience for that specific position.
+
+## Features
+
+- 📄 **PDF Resume Upload**: Easy drag-and-drop PDF processing
+- 🔗 **Job URL Analysis**: Automatically extracts job requirements from posting URLs
+- 🤖 **AI-Powered Optimization**: Uses CrewAI and GPT-4o Mini for intelligent resume tailoring
+- ⚡ **Rate Limited**: 3 requests per 5 minutes to manage API costs
+- 🎨 **Clean Interface**: User-friendly Gradio interface
+
+## How It Works
+
+1. **Upload** your current resume as a PDF
+2. **Paste** the job posting URL you're applying to
+3. **Click** "Generate Tailored Resume"
+4. **Get** an optimized resume that matches the job requirements
+
+## The AI Process
+
+The app uses a multi-agent system:
+- **Job Requirements Analyst**: Extracts key requirements from job postings
+- **Resume Enhancement Specialist**: Optimizes your resume to match those requirements
+
+## Setup for Hugging Face Spaces
+
+### Environment Variables
+Set these in your Hugging Face Space settings:
+
+- `OPENAI_API_KEY`: Your OpenAI API key
+- `SERPER_API_KEY`: Your Serper API key (for web scraping)
+
+### Files Structure
+```
+├── app.py              # Main application
+├── requirements.txt    # Dependencies
+└── README.md          # This file
+```
+
+## Rate Limiting
+
+To manage API costs, the app is limited to:
+- **3 requests per 5 minutes** per user
+- Efficient processing to minimize API calls
+
+## Supported Job Sites
+
+The app works with most job posting URLs including:
+- LinkedIn Jobs
+- Company career pages
+- Job boards like Lever, Greenhouse, etc.
+- Any publicly accessible job posting
+
+## Privacy
+
+- Your PDF is processed temporarily and not stored
+- No personal data is retained after processing
+- All processing happens securely in the cloud
+
+## Technical Details
+
+- **Framework**: Gradio for the interface
+- **AI**: CrewAI with OpenAI GPT-4o Mini
+- **PDF Processing**: PyPDF2 for text extraction
+- **Rate Limiting**: Custom implementation to manage API usage
+
+## Tips for Best Results
+
+1. **Upload a comprehensive PDF resume** with all your experience
+2. **Use the complete job posting URL** (not shortened links)
+3. **Wait for processing** - it takes 1-2 minutes to generate results
+4. **Review the output** and make final adjustments as needed
+
+---
+
+*Built with ❤️ using CrewAI, OpenAI, and Gradio*