diff -r 0ab737feada6 -r 4d73a1a6ba68 mod_swedishchef/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_swedishchef/README.markdown	Fri Aug 28 18:03:58 2015 +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