mod_pep_vcard_png_avatar: Add a README
authorMichel Le Bihan <michel@lebihan.pl>
Sun, 26 Jun 2016 18:20:25 +0200
changeset 2222 0ca0fdad3b2c
parent 2221 7be1ca7a51a4
child 2223 5fcf9d558250
mod_pep_vcard_png_avatar: Add a README
mod_pep_vcard_png_avatar/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pep_vcard_png_avatar/README.markdown	Sun Jun 26 18:20:25 2016 +0200
@@ -0,0 +1,26 @@
+Introduction
+============
+
+Conversations (an XMPP client for Android) is publishing PEP avatars in the webp file format. However Pidgin and other XMPP desktop clients can only show vcard avatars, that are in the PNG file format. This module is the [mod_pep_vcard_avatar](https://modules.prosody.im/mod_pep_vcard_avatar.html) module extended to also change the avatar file format to PNG.
+
+Configuration
+=============
+
+Enable the module as any other:
+
+    modules_enabled = {
+      "mod_pep_vcard_png_avatar";
+    }
+
+You MUSTN'T load mod\_pep\_vcard\_avatar if this module is loaded.
+
+Compatibility
+=============
+
+  ----- -------------
+  trunk Works
+  0.10  Should work
+  0.9   Should work
+  ----- -------------
+
+