From 515b9aa317e9a3584db5507db490b922f024acba Mon Sep 17 00:00:00 2001
From: stefiosif <si.iosifidis@gmail.com>
Date: Sun, 15 Mar 2026 15:23:05 +0200
Subject: [PATCH] Update README

---
 README.md | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 858d179..954f388 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,18 @@
-# Tauri + SvelteKit + TypeScript
+<h1 align="center">rota</h1>
 
-This template should help get you started developing with Tauri, SvelteKit and TypeScript in Vite.
+Desktop app for generating monthly schedules for medical residents. The scheduling engine uses a parallel constraint-satisfaction DFS with a least-flexibility-first heuristic.
 
-## Recommended IDE Setup
+### Features
+- Configurable residents, shift types, and forbidden pairings
+- Negative shift requests and manual pre-assignments
+- Fairness-aware workload distribution
+- Export to `.docx` and `.txt`
 
-[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).
+### Stack
+- **Frontend**: SvelteKit + TypeScript + Tailwind CSS
+- **Backend**: Rust (Tauri)
+
+### Usage
+```bash
+just --list
+```