Readme

README.md

@@ -27,9 +27,9 @@ tags:
 
 # Pay Equity for EU
 
-A grounded, citation-first assistant that answers two questions Danish
-graduates ask every job offer: **"What pay should I expect?"** and **"What does
-the law actually let me ask for?"**
+A user-friendly salary expectation tool for (currently) any danish engineers, to get an idea of what they deserve as a salary after suffering years of studies. Embark yourself in my app and see what salary you should be expecting in your future dream job, or even get to know what salary you actually should be having if you currently have a job! In parallel with an accessible salary overview, you can chat with a grounded, citation-first assistant that answers any questions you might have to prepare your next salary-talk or job-interview!
+
+ **"What pay should I expect?"** and **"What does the law actually let me ask for?"**
 
 ## Why I built this
 
@@ -53,27 +53,23 @@ in France.
 
 ## The problem
 
-In Denmark, salary negotiation is famously opaque. New graduates rarely know
-what the market pays, and the data that *does* exist sits behind union paywalls
-in long PDFs. On top of that, the EU recently passed the **Pay Transparency
-Directive (2023/970)**, which gives every employee the right to ask their
-employer for pay information, gender pay-gap reports, and more. The catch: it's
-80 pages of legalese, in 24 languages, and almost no one has read it. So people
-sign offers without knowing either the number or the rights they already have.
+In Denmark, salary negotiation is quite vague. New graduates rarely know
+what the market pays, and how much they are actually worth compared to their peers. On top of that, the EU recently passed the **Pay Transparency
+Directive (2023/970)**, which gives every employee the right to ask their employer for pay information, gender pay-gap reports, and more. But who understands what's written on these reports? So people
+sign offers without knowing either the number or the rights they already have...
 
-This app fixes both, in one chat.
+This app fixes both, in one chat and an accessible user-salary-creation (do not worry, you will not be disclosing anything private!)
 
 ## What it does
 
 - **Expected pay** — deterministic lookup over parsed IDA *lønstatistik*
   (salary statistics from the engineers' union), broken down by sector,
-  experience, and role. No hallucinations: numbers come straight from the
-  union's published tables.
+  experience, and role. I use all this metadata to perform precise and effective salary chunk query.
 - **Your rights** — RAG over the EU Pay Transparency Directive with
   article-level citations on every claim (e.g. *"You can request the
   average pay for your role broken down by gender (Art. 7(1))"*). Answers are
   in **English** in v1; the directive text is already parsed in DA / FR and the
-  generation model is multilingual, so localized answers are a fast follow.
+  generation model is multilingual, so localized answers are an easy implementation!
 - **Private document review** — session-only upload of a contract or payslip,
   never persisted, never sent to a third-party API.
 
@@ -86,12 +82,11 @@ professional association (*fagforening* is simply Danish for "trade union"). IDA
 surveys its members every year and publishes detailed pay tables by education,
 sector, region, seniority, role, and gender. Those tables are exactly the
 ground truth an engineer needs to answer "what should I earn?", so they are the
-foundation here. I started with engineers because that is who I am and who my
-friends are, and because I can judge whether the answers are right.
+foundation here. I started with engineers since I am myself one and I know that salary conversations are always a pain.
 
 ## Future goals
 
-The plumbing is general; the data is what's scoped. Two clear extensions:
+There are two future goals which I would love to extend on:
 
 ### Extend to Djøf
 
@@ -108,9 +103,7 @@ huge share of Danish white-collar graduates beyond engineering.
 
 I am also French, and the EU Pay Transparency Directive applies across the whole
 European Union, not just Denmark. Each member state (including France) must turn
-it into national law by June 2026, so the "what are my rights?" half already
-generalizes. The next step there is to plug in French salary data sources so a
-French engineer gets the same profile-driven benchmark a Danish one does today.
+it into national law by June 2026, so the "what are my rights?" is also a fair question an frenchman could aks himself (that would then be "Quelles sont mes droits?!"). The next step there is to plug in French salary data sources so a French engineer gets the same profile-driven benchmark a Danish one does today.
 
 ## Hackathon track
 
@@ -126,7 +119,7 @@ for a real circle of people (Danish graduates job-hunting right now).
 | Embeddings | **NVIDIA Nemotron-Embed 1B v2** | Strong multilingual retrieval, ungated |
 | Retrieval | FAISS IndexFlatIP + per-source top-k + Reciprocal Rank Fusion | Keeps salary numbers and legal text from drowning each other |
 | Runtime | Gradio Server + ZeroGPU on HF Spaces | FastAPI-style `@app.api` endpoints behind a custom JS frontend |
-| Frontend | **Hand-authored HTML / CSS / JS SPA** (no Gradio Blocks at the root) | Onboarding wizard → profile-driven dashboard with hand-drawn SVG charts (bell curve, gauge, comparison bars) → contextual rights chat with seeded questions, served on top of `gradio.Server` via the JS client |
+| Frontend | **Hand-authored HTML / CSS / JS SPA** (no Gradio Blocks at the root) | Onboarding questionaire → profile-driven dashboard with hand-drawn SVG charts (bell curve, gauge, comparison bars) → contextual rights chat with seeded questions, served on top of `gradio.Server` via the JS client |
 | Type / palette | Bricolage Grotesque + Inter on a sage / ink Scandinavian palette | Goes well beyond default Gradio look |
 
 All model revisions are pinned by SHA in `configs/models.yaml`. No `latest`.
@@ -144,7 +137,7 @@ checked against a citation. A small, transparent stack is the *right* tool for
 
 ## Demo video
 
-[Watch the demo](TODO_YOUTUBE_URL)
+[Watch the demo](https://youtu.be/TulJ8n-uR3A)
 
 ## Social post