From 555d2a871b9a5ce0a95324bc8a4f643fc086ce12 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim=20Gr=C3=B6ger?= <tim@groeger-clan.de>
Date: Sat, 31 Oct 2020 15:38:20 +0100
Subject: [PATCH] Update Readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0e98c90..c0409f1 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,26 @@ Dynamischen Managementsystem für Studentenclubs
 npm install
 ```
 
+## Plugins
+### Build a Plugin
+A Flaschengeist-Frontend-Plugin should be placed in `src/plugins`.
+It needs a `plugin.ts` File which exports a plugin with the following interface:
+```
+name: string;
+mainRoutes?: PluginRouteConfig[];
+outRoutes?: PluginRouteConfig[];
+store?: Map<string, Module<any, StateInterface>>;
+requiredModules: string[];
+version: string;
+```
+
+You have to import `FG_Plugin` from `plugins.d.ts`.
+
+### Configure Plugin
+
+You can activate and deactive Plugins in `src/boot/plugins.ts`. You have to set the name of the Plugin into `config.loadModules`.
+The order of the plugins is importend!
+
 ### Start the app in development mode (hot-code reloading, error reporting, etc.)
 ```bash
 quasar dev
@@ -21,6 +41,7 @@ npm run lint
 ```bash
 quasar build
 ```
-
+<!--
 ### Customize the configuration
 See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
+-->