diff --git a/README.md b/README.md index f148b5b65553c6c569e2955e90617bc5cdbd8927..e1d956389d725eede513ea53c4ea7dd71d936601 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