From 52167cec75795b15aed4f6cc2f5784e405867be3 Mon Sep 17 00:00:00 2001
From: Marcus Fihlon <marcus@fihlon.swiss>
Date: Sat, 13 Jul 2024 20:26:20 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=92=84=20add=20docs=20for=20custom=20styl?=
 =?UTF-8?q?es=20of=20Java=20Forum=20Stuttgart?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Marcus Fihlon <marcus@fihlon.swiss>
---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cbc16fb1..d5f1824e 100644
--- a/README.md
+++ b/README.md
@@ -124,7 +124,7 @@ The environment variables will override the default values. Some default values
 1. https://meine.doag.org/api/event/action.getCPEventAgenda/eventId.%d/
 2. https://sessionize.com/api/v2/%s/view/Sessions
 
-#### Custom Styles
+### Custom Styles
 
 You can modify the styles of the user interface using CSS variables. The CSS variables must be set using the environment variable `CUSTOM_STYLES` in key and value pairs. The key is the variable to be set and must start with two dashes (`--`). Keys and values must be separated by a colon (`:`). Multiple key and value pairs are separated by a semicolon (`;`). Example:
 
@@ -147,6 +147,23 @@ The following table contains the CSS variables you can modify to change the user
 | --social-post-background-color | #84ddee | The color for the background of social posts.                      |
 | --social-post-border           | none    | The border for the social posts.                                   |
 
+The custom styles of some events are documented below.
+
+#### Java Forum Stuttgart
+
+```
+--event-background-color:#FCB913;
+--event-text-color: #000000;
+--event-running-session-color: #FFF8DD;
+--event-next-session-color: #FFF8DD;
+--event-closed-room-color: #FFF8DD;
+--social-background-color: #FFF8DD;
+--social-text-color: #000000;
+--social-post-background-color: #FFFFFF;
+--event-room-border: 1px solid #000000;
+--social-post-border: 1px solid #FCB913;
+```
+
 ### Create Hashed Password
 
 For security reasons the password is not stored in cleartext. *Apus* requires the password to be hashed using [bcrypt](https://en.wikipedia.org/wiki/Bcrypt). Of course, *Apus* can do this for you. Start the JAR file providing the parameter `-p` followed by the password you want to create a hash for. The output will show you two lines of code. The first line contains the hashed password and the second line contains the same hashed password, but with the dollar signs escaped ready to copy and paste it into a `docker-compose.yaml`. Example:
@@ -249,6 +266,44 @@ Everyone is welcome to contribute a plugin themselves. The implementation is ver
 
 If your implementation requires a configuration, the `Configuration` class must be extended accordingly. Add a property and corresponding setters and getters in the marked sections. Implement the settings object as a `record` in your new plugin package. Take one of the existing plugins as a template. Default settings belong in the file `application.properties` and the corresponding schema is stored in `additional-spring-configuration-metadata.json`. Of course, this `README.md` must also be adapted.
 
+#### Event Plugin
+
+##### Constructor
+
+TODO: Explain constructor with dependency injection
+
+##### Method `isEnabled`
+
+TODO: Explain method
+
+##### Method `getSessions`
+
+TODO: Explain method
+
+##### Record `Session`
+
+TODO: Explain record
+
+##### Enum `Language`
+
+TODO: Explain enum
+
+##### Record `Room`
+
+TODO: Explain record
+
+##### Record `Speaker`
+
+TODO: Explain record
+
+##### Record `Track`
+
+TODO: Explain record
+
+#### Social Plugin
+
+TODO: Explain the `SocialPlugin` methods and related classes (`Post`)
+
 ## Communication
 
 ### Matrix Chat