docs in sub package

docs/README.md

@@ -1,50 +1,21 @@
-- [TibiCMS](../README.md)
-- [Begriffe](begriffe.md)
-- Servergrundlagen
-    - [Konfiguration](servergrundlagen/konfiguration.md)
-    - [Entitäten](servergrundlagen/entitaeten.md)
-- RestAPI Endpunkte
-    - [/login](restapi/login.md)
-    - [/user](restapi/user.md)
-    - [/project](restapi/project.md)
-    - [/_/NS/COLLECTION](restapi/collection.md)
-    - [/_/NS/_/assets/ASSETSNAME](restapi/assets.md)
-- Projekt Konfiguration
-    - [Ordnerstruktur](projektkonfig/ordnerstruktur.md)
-    - [config.yml](projektkonfig/config.yml.md)
-    - [collections](projektkonfig/collections.md)
-        - [fields](projektkonfig/collections/fields.md)
-            - [Datentypen](projektkonfig/collections/fields/datentypen.md)
-            - [Admin Widgets](projektkonfig/collections/fields/widgets.md)
-                - [· ContentBuilder](projektkonfig/collections/fields/widgets/contentbuilder.md)
-        - [indexes](projektkonfig/collections/indexes.md)
-        - [hooks](projektkonfig/collections/hooks.md)
-        - [imageFilter](projektkonfig/collections/imageFilter.md)
-        - [meta](projektkonfig/collections/meta.md)
-    - [jobs](projektkonfig/jobs.md)
-    - [assets](projektkonfig/assets.md)
-- Admin Javascript Kontext
-    - [Allgemeines](admin-javascript-kontext/allgemeines.md)
-    - [collection.meta..eval](admin-javascript-kontext/collection.meta..eval.md)
-    - [field.meta..eval](admin-javascript-kontext/field.meta..eval.md)
-- Server Javascript Kontext
-    - [Allgmeines](server-javascript-kontext/allgemeines.md)
-    - [hook](server-javascript-kontext/hook.md)
-    - [job](server-javascript-kontext/job.md)
-    - [validator](server-javascript-kontext/validator.md)
-    - Packages
-        - [user](server-javascript-kontext/packages/user.md)
-        - [response](server-javascript-kontext/packages/response.md)
-        - [cookie](server-javascript-kontext/packages/cookie.md)
-        - [db](server-javascript-kontext/packages/db.md)
-        - [http](server-javascript-kontext/packages/http.md)
-        - [smtp](server-javascript-kontext/packages/smtp.md)
-        - [fs](server-javascript-kontext/packages/fs.md)
-        - [tpl](server-javascript-kontext/packages/tpl.md)
-        - [jwt](server-javascript-kontext/packages/jwt.md)
-        - [image](server-javascript-kontext/packages/image.md)
-        - [bcrypt](server-javascript-kontext/packages/bcrypt.md)
-        - [xml](server-javascript-kontext/packages/xml.md)
-        - [charset](server-javascript-kontext/packages/charset.md)
-        - [pdf](server-javascript-kontext/packages/pdf.md)
-        - [debug](server-javascript-kontext/packages/debug.md)
+# TibiCMS Dokumentation
+
+![TibiCMS Aufbau](./md/tibi-aufbau.svg)
+
+## Einleitung
+
+_TibiCMS_ ist der Sammelbegriff für die Komponenten _tibi-server_ und _tibi-admin_, welche einen Rest-API Server und eine Administrationsoberfläche zur Verfügung stellen. Auf Basis dieser beiden Komponenten und der _MongoDB_ als Abhängigkeit lassen sich WebCMS Anwendungen abbilden.
+
+Das CMS ist multi-mandanten-fähig, d.h. es kann mehrer Projekte mit unterschiedlichen Zugriffsbeschränkungen verwalten.
+
+### tibi-server
+
+Der Server selbst kommt ohne grafische Oberfläche oder WebUI. Er ist ausschließlich nach außen über eine Rest-API erreichbar.
+
+Als einzige Abhängigkeit ist eine _MongoDB_ zu erwähnen. Da der Server in Go geschrieben ist, sind keine externen Bibliotheken notwendig. Er lässt sich daher prima via Docker-Container verteilen.
+
+### tibi-admin
+
+Die Administrationsoberfläche ist wie jeder andere Service, der die Rest-API des Servers nutzt, nur ein Frontend. _tibi-admin_ läuft vollständig im Browser und benötigt nur einen Webserver, der statischen Content ausliefert.
+
+Die Version des _tibi-admin_ sollte synchron zur _tibi-server_ Version gehalten werden, damit alle Datentypen bedient werden können.