From f8a1718e71f24db7aa372bf8721e6236f6d974f4 Mon Sep 17 00:00:00 2001
From: Alex Reinhardt <Alexander.Reinhardt@tu-dortmund.de>
Date: Mon, 3 Apr 2023 15:26:26 +0200
Subject: [PATCH] Update README.md

---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f148b5b..e1d9563 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,10 @@
 # oh14.de Kurzlinks
 
-Unter https://oh14.de/vanitymap.json gibt es alle Kurzlinks und ihre Ziele als JSON-Datei.
+Die Kurzlinks sind in der `kurzlinks.yaml` zu finden.
+Jeder Kurzlink besteht aus:
+- Einer `destination`: Die Seite, auf die der Kurzlink weiterleitet
+- Einer oder mehreren `sources`: Die Namen des Kurzlinks
+- Einer `description`: Ein kurzer Text, der den Kurzlink beschreibt
+- Einem oder mehreren `tags`: Kategorien, in die der Kurzlink passt
+
+In der `kurzlinks.yaml` ist zudem eine Liste von Tags zusammen mit einer `description` für jeden Tag.
\ No newline at end of file
-- 
GitLab