From dc75eabcf5a8d2312aaa9d2f960712df9ed2f4b4 Mon Sep 17 00:00:00 2001
From: Rai-Ka <github@rainer-kehnen.de>
Date: Sat, 4 Nov 2023 00:24:25 +0100
Subject: [PATCH] doc: describe plugin's generell outlook and intent

---
 README.md               |  46 ++++++++++++++++
 Ziehungsmuster.md       |  20 +++++++
 markdown-cheat-sheet.md | 119 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 185 insertions(+)
 create mode 100644 Ziehungsmuster.md
 create mode 100644 markdown-cheat-sheet.md

diff --git a/README.md b/README.md
index f95b806..a8b8f74 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,48 @@
 # rkWichteln.git
  
+# FamilienWichteln - ein Plugin für's Weihnachtliche Wichteln.
+
+# Plugin Conversion for Wordpress
+
+# Bestandteile und Aufbau
+## Teilnehmer und Wichtelgruppe
+- User ist Teilnehmer
+- Jeder Teilnehmer kann Wunschlisten anlegen und verwalten, die für alle sichtbar sind.
+- Jeder Teilnehmer hat ggfls. einen oder mehr Partner
+    - Liste Partner
+- Teilnehmer gehören einer oder mehreren Wichtelgruppen an
+- Jeder Teilnehmer einer Wichtelgruppe zieht einen Wichtelpartner aus der gleichen Gruppe
+- I.d.R. dürfen Teilnehmer keine eigenen Partner ziehen
+
+## Wichtelgruppe
+- Wichtelgruppe ist eine Sammlung von Teilnehmern
+- Ein User ist Verwalter der Gruppe, muss kein Teilnehmer der Gruppe sein.
+    ### Aufgaben des Verwalters
+    - Aufnahme und Löschung von Usern als Teilnehmer der verwalteten Gruppe
+    - Partnerzuweisung macht der User selbst in seinem Profil?
+      oder doch der Verwalter (Partner könne in den unterschiedlichen Gruppen unterschiedlich sein)
+    - Start der Ziehung
+    - Beendigung der Ziehung
+    - Kontrolle...
+
+## erste Umsetzung technisch
+- User der Familie anlegen
+- Wunschliste(n)
+    - Zuordnung der liste zu Teilnehmer oder User?
+- Partnerliste:
+    - Person -> Partner
+    - Partner -> Person
+    --> Hash!
+- Wichtelgruppenliste
+    - Teilnehmer
+
+- Wichtelpartnerliste der Wichtelgruppe
+    - Teilnehmer
+        - gezogen?
+            - Wichtelpartner
+        - nicht gezogen?
+            - 
+
+- Vorbelegung der Wichtelpartner?
+- Ziehung zur Vorbelegung
+- Ziehung "on the fly"
\ No newline at end of file
diff --git a/Ziehungsmuster.md b/Ziehungsmuster.md
new file mode 100644
index 0000000..3ae6f45
--- /dev/null
+++ b/Ziehungsmuster.md
@@ -0,0 +1,20 @@
+# Test Ziehung
+
+- Vater - Mutter
+- Mutter - Vater
+- Rainer - Vinya
+- Vinya - Rainer
+- Martin - Claudia
+- Claudia - Martin
+- Petra - Kalle
+- Kalle - Petra
+
+
+Vater
+Mutter
+Rainer
+Vinya
+Martin
+Claudia
+Petra
+Kalle
diff --git a/markdown-cheat-sheet.md b/markdown-cheat-sheet.md
new file mode 100644
index 0000000..c94cb27
--- /dev/null
+++ b/markdown-cheat-sheet.md
@@ -0,0 +1,119 @@
+# Markdown Cheat Sheet
+
+Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!
+
+This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax/) and [extended syntax](https://www.markdownguide.org/extended-syntax/).
+
+## Basic Syntax
+
+These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
+
+### Heading
+
+# H1
+## H2
+### H3
+
+### Bold
+
+**bold text**
+
+### Italic
+
+*italicized text*
+
+### Blockquote
+
+> blockquote
+
+### Ordered List
+
+1. First item
+2. Second item
+3. Third item
+
+### Unordered List
+
+- First item
+- Second item
+- Third item
+
+### Code
+
+`code`
+
+### Horizontal Rule
+
+---
+
+### Link
+
+[Markdown Guide](https://www.markdownguide.org)
+
+### Image
+
+![alt text](https://www.markdownguide.org/assets/images/tux.png)
+
+## Extended Syntax
+
+These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
+
+### Table
+
+| Syntax | Description |
+| ----------- | ----------- |
+| Header | Title |
+| Paragraph | Text |
+
+### Fenced Code Block
+
+```
+{
+  "firstName": "John",
+  "lastName": "Smith",
+  "age": 25
+}
+```
+
+### Footnote
+
+Here's a sentence with a footnote. [^1]
+
+[^1]: This is the footnote.
+
+### Heading ID
+
+### My Great Heading {#custom-id}
+
+### Definition List
+
+term
+: definition
+
+### Strikethrough
+
+~~The world is flat.~~
+
+### Task List
+
+- [x] Write the press release
+- [ ] Update the website
+- [ ] Contact the media
+
+### Emoji
+
+That is so funny! :joy:
+
+(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))
+
+### Highlight
+
+I need to highlight these ==very important words==.
+
+### Subscript
+
+H~2~O
+
+### Superscript
+
+X^2^
\ No newline at end of file