Diff

mod_swedishchef/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 1803:4d73a1a6ba68
child 6099:3a023f1d6c08
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_swedishchef/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,36 @@
+---
+labels:
+- 'Stage-Beta'
+summary: 'Silly little module to convert your conversations to "swedish"'
+...
+
+Introduction
+============
+
+This module does some conversions on message bodys passed through it
+causing them to look like our beloved swedish chef had typed them.
+
+Details
+=======
+
+To load this on a MUC component do
+
+    Component "funconference.example.com" "muc"
+        modules_enabled = { "swedishchef" }
+        swedishchef_trigger = "!chef"; -- optional, converts only when the message starts with "!chef"
+
+In theory this also works for whole servers, but that is untested and
+not recommended ;)
+
+Compatibility
+=============
+
+  ----- -------
+  0.6   Works
+  0.5   Works
+  ----- -------
+
+Todo
+====
+
+-   Possibly add xhtml-im (XEP-0071) support