ahmednoorx commited on
Commit
f8a0c6c
Β·
verified Β·
1 Parent(s): 59cd773

Fix corrupted README.md metadata

Browse files
Files changed (1) hide show
  1. README.md +52 -12
README.md CHANGED
@@ -1,12 +1,52 @@
1
- ---
2
- title: Cold Email Assistant
3
- emoji: 🐨
4
- colorFrom: green
5
- colorTo: purple
6
- sdk: gradio
7
- sdk_version: 5.35.0
8
- app_file: app.py
9
- pinned: false
10
- ---
11
-
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Cold Email Outreach Assistant
3
+ emoji: βœ‰οΈ
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: streamlit
7
+ sdk_version: 1.28.0
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ # πŸ“§ Cold Email Outreach Assistant
14
+
15
+ A powerful AI-driven tool for generating personalized cold emails using company intelligence and open-source models.
16
+
17
+ ## πŸš€ Features
18
+
19
+ - **CSV Upload**: Process leads with name, email, company, LinkedIn URL
20
+ - **Smart Scraping**: Extract company info from LinkedIn and websites
21
+ - **AI Email Generation**: Create personalized emails using Vicuna-7B model
22
+ - **Multiple Tones**: Professional, Friendly, Direct, Authoritative
23
+ - **Quality Control**: Built-in scoring and validation
24
+ - **Export Results**: Download generated emails as CSV
25
+
26
+ ## πŸ“Š Input Format
27
+
28
+ Upload a CSV with these columns:
29
+
30
+ ```csv
31
+ name,email,company,linkedin_url
32
+ John Smith,[email protected],TechCorp Inc,https://linkedin.com/company/techcorp
33
+ ```
34
+
35
+ ## 🎯 How to Use
36
+
37
+ 1. **Upload CSV**: Click "Choose file" and select your leads CSV
38
+ 2. **Configure Settings**: Choose tone and creativity level in sidebar
39
+ 3. **Process Leads**: Click "Generate Cold Emails" to start processing
40
+ 4. **Review Results**: Check generated emails with quality scores
41
+ 5. **Export**: Download results as CSV for your outreach campaign
42
+
43
+ ## πŸ”§ Technical Details
44
+
45
+ - **AI Model**: Vicuna-7B GGUF (runs locally, no API keys needed)
46
+ - **Scraping**: BeautifulSoup + Selenium fallback
47
+ - **Caching**: SQLite database for efficiency
48
+ - **Framework**: Streamlit for web interface
49
+
50
+ ## πŸ“ License
51
+
52
+ MIT License - Free for commercial use