From 733178841489750c6e60025bd1b127f323452325 Mon Sep 17 00:00:00 2001 From: Marcus Fihlon Date: Thu, 18 Apr 2024 09:02:28 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20add=20plugin=20documentation=20c?= =?UTF-8?q?loses=20#58?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 5fba54c..d4d19e5 100644 --- a/README.md +++ b/README.md @@ -178,6 +178,32 @@ Short explanation, consult the Docker or Podman documentation for more informati Modify this command according your needs and consult the [configuration section](#configuration) above for more information about how to configure *Apus*. The Docker image of *Apus* will be pulled from [Docker Hub](https://hub.docker.com/) automatically when not available locally. +## Plugin Support + +### Conference Plugins + +*Apus* uses a simple plugin technology to import the agenda of various events. Plugins are currently available for the following events: + +| Plugin | Supported Events | +|--------------|----------------------------------------------| +| `DoagPlugin` | CloudLand, CyberLand, JavaLand, KI Navigator | + +Plugins for other events are planned. Everyone is welcome to contribute a plugin themselves. The implementation is very simple. For a new plugin, a new package is created under `swiss.fihlon.apus.plugin.conference`. The implementation is carried out in this package. The corresponding class must implement the interface `ConferencePlugin`. + +If the implementation requires a configuration, the package `swiss.fihlon.apus.configuration` must be extended accordingly. Default settings belong in the file `application.properties` and the corresponding schema is stored in `additional-spring-configuration-metadata.json`. Of course, `README.md` must also be adapted. + +### Social Plugins + +*Apus* uses a simple plugin technology to import posts from various social media services. Plugins are currently available for the following services: + +| Plugin | Supported Services | +|------------------|--------------------| +| `MastodonPlugin` | Mastodon | + +Plugins for other social services are planned. Everyone is welcome to contribute a plugin themselves. The implementation is very simple. For a new plugin, a new package is created under `swiss.fihlon.apus.plugin.social`. The implementation is carried out in this package. The corresponding class must implement the interface `SocialPlugin`. + +If the implementation requires a configuration, the package `swiss.fihlon.apus.configuration` must be extended accordingly. Default settings belong in the file `application.properties` and the corresponding schema is stored in `additional-spring-configuration-metadata.json`. Of course, `README.md` must also be adapted. + ## Communication ### Matrix Chat