diff --git a/README.md b/README.md index 8ec921b..5caadb0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,41 @@ # 📧 Cold Mail Generator Cold email generator for services company using groq, langchain and streamlit. It allows users to input the URL of a company's careers page. The tool then extracts job listings from that page and generates personalized cold emails. These emails include relevant portfolio links sourced from a vector database, based on the specific job descriptions. -**Imagine a scenario:** +## 📋 Example Use Case -- Nike needs a Principal Software Engineer and is spending time and resources in the hiring process, on boarding, training etc -- Atliq is Software Development company can provide a dedicated software development engineer to Nike. So, the business development executive (Mohan) from Atliq is going to reach out to Nike via a cold email. +Imagine **Mohan**, a Business Development Executive at **Atliq** (a software development company). + +- **Goal:** Reach out to **Nike** who is hiring a **Principal Software Engineer**. +- **Challenge:** Manually researching the job, writing a personalized email, and finding relevant case studies is time-consuming. +- **Solution:** + 1. Mohan copies Nike's careers page URL into the tool. + 2. The tool finds the "Principal Software Engineer" listing. + 3. It generates a personalized email highlighting Atliq's expertise. + 4. It automatically includes links to specific portfolio projects involving scalable architecture and cloud solutions, making the outreach instantly more relevant and compelling. ![img.png](imgs/img.png) + +## ✨ Features + +- **🔗 URL-Based Job Scraping:** Automatically extracts job listings from company career pages. +- **🤖 AI-Personalization:** Leverages Groq and LangChain to generate compelling email content tailored to each specific job description. +- **📂 Smart Portfolio Matching:** Connects to a vector database to find and suggest the most relevant case studies and portfolio pieces for the job. +- **🎨 Streamlit UI:** Simple, clean, and intuitive web interface for easy interaction. + ## Architecture Diagram ![img.png](imgs/architecture.png) -## Set-up + + +## 🚀 Getting Started + +### Prerequisites +- Python 3.8+ +- A free [Groq](https://console.groq.com/) API key. + +### Installation & Setup + 1. To get started we first need to get an API_KEY from here: https://console.groq.com/keys. Inside `app/.env` update the value of `GROQ_API_KEY` with the API_KEY you created.