resume-insights/README.md

CLI tool to analyze how well your resume matches a job description based on keyword comparison

# 📄 resume-insights

> 🔍 A CLI tool to analyze how well your resume matches a job description using keyword extraction and matching.

🎯 Get an instant **match score**, a list of **missing keywords**, and actionable **suggestions**.  
📄 Output is also saved to a `resume-analysis.txt` file.

---


## 🚀 Features

- ✅ Extracts text from resumes (PDF)
- ✅ Tokenizes & cleans job description
- ✅ Removes stopwords & generic sections
- ✅ Compares and scores keyword overlap
- ✅ Lists missing keywords
- ✅ Outputs results to terminal and file
- ✅ No setup — run directly with `npx`

---


## 📦 Installation

### Use via `npx` (No Install Needed)

```bash
npx resume-insights <resume.pdf> <job-description.txt>
Or install globally

npm install -g resume-insights


🧪 Usage ->

resume-insights resume.pdf job-description.txt



🧠 How It Works
Parses resume (PDF) and job description (TXT)

Cleans and tokenizes both texts

Filters out stopwords and section labels

Compares overlap and calculates:

✅ Match Score

✅ Missing Keywords

✅ Suggestions

Saves output in terminal and resume-analysis.txt

📁 Output ->

A text file named resume-analysis.txt is saved:

📥 Inputs ->

File Type	                 Description
resume.pdf	           Your resume in PDF format
job-description.txt    Plain text job description


📜 License
MIT License