From 9d907d3e5a6eb6799301318053bad99724351cff Mon Sep 17 00:00:00 2001
From: Agathe Badia <ab@honeypot.io>
Date: Sat, 2 Mar 2024 16:42:22 +0100
Subject: [PATCH] Update README.md

---
 README.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 72f6d84..f040f35 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,18 @@
 # bildungsurlaub
 
-This README outlines the details of collaborating on this Ember application.
-A short introduction of this app could easily go here.
+How to: Bildungsurlaub - Residents in Germany who need information about education leave, eligibility and how to guides
+
+Status: WIP 
+TODO:
+* Update Mermaid flowchart to a complete state
+* Actions to request Bildungsurlaub as an employee
+* Actions to find a Bildungsurlaub
+* English & German request to Bildungs to send to HR + copy to clipboard
+* Finish table of content + accessibility via tab navigation
+* Add additional links, resources, articles
+* Add logo to the platform
+* A11y check (colorblind extension + Lighthouse)
+* Mobile layout/responsive check
 
 ## Prerequisites