Added to README

README.md

@@ -1,3 +1,70 @@
+# Resumate
+
+[![Python CI](https://github.com/gperdrizet/resumate/actions/workflows/python_ci.yml/badge.svg)](https://github.com/gperdrizet/resumate/actions/workflows/python_ci.yml)[![HuggingFace Space](https://github.com/gperdrizet/resumate/actions/workflows/publish_hf_space.yml/badge.svg)](https://github.com/gperdrizet/resumate/actions/workflows/publish_hf_space.yml)[![Codespaces Prebuilds](https://github.com/gperdrizet/resumate/actions/workflows/codespaces/create_codespaces_prebuilds/badge.svg)](https://github.com/gperdrizet/resumate/actions/workflows/codespaces/create_codespaces_prebuilds)
+
+Resumate is a simple web app that helps you generate a tailored resume for a specific job post. It collects your LinkedIn profile (PDF export), GitHub profile URL, and the job post text, then processes this information to help you create a resume that matches the job requirements.
+
+## Features
+- Upload your LinkedIn resume export (PDF)
+- Provide your GitHub profile URL (public repos only)
+- Paste the job post text
+- Optionally add custom instructions for the resume writer agent
+- Get a tailored resume output in seconds
+
+---
+
+## 🚀 Quickstart (Recommended: GitHub Codespaces)
+
+1. **Open in Codespaces**
+   - Click the "Code" button on GitHub and select "Open with Codespaces".
+   - Codespaces will automatically set up the environment.
+2. **Install dependencies** (if not pre-installed):
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. **Run the app:**
+   ```bash
+   python resumate.py
+   ```
+4. **Open the provided URL** in your browser to use the Gradio UI.
+
+---
+
+## 🖥️ Running Locally with Virtualenv
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/gperdrizet/resumate.git
+   cd resumate
+   ```
+2. **Create and activate a virtual environment:**
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   ```
+3. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+4. **Run the app:**
+   ```bash
+   python resumate.py
+   ```
+5. **Open the provided URL** in your browser to use the Gradio UI.
+
+---
+
+## 📄 LinkedIn PDF Export Instructions
+1. Go to your LinkedIn profile page
+2. Click the "More" button (three dots)
+3. Select "Save to PDF"
+4. Wait for the download
+5. Upload the PDF in the app
+
+---
+
+## License
+MIT License
 ---
 title: Resumate
 colorFrom: blue
@@ -10,12 +77,3 @@ license: gpl-3.0
 short_description: Tailored resume generation
 ---
 
-# resumate
-
-[![Python CI](https://github.com/gperdrizet/resumate/actions/workflows/python_ci.yml/badge.svg)](https://github.com/gperdrizet/resumate/actions/workflows/python_ci.yml)
-
-[![HuggingFace Space](https://github.com/gperdrizet/resumate/actions/workflows/publish_hf_space.yml/badge.svg)](https://github.com/gperdrizet/resumate/actions/workflows/publish_hf_space.yml)
-
-[![Codespaces Prebuilds](https://github.com/gperdrizet/resumate/actions/workflows/codespaces/create_codespaces_prebuilds/badge.svg)](https://github.com/gperdrizet/resumate/actions/workflows/codespaces/create_codespaces_prebuilds)
-
-Resume tailoring agent with LaTex typesetting, GitHub profile RAG and LinkedIn biographical context tools.