--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_muconference_readonly/README.markdown	Thu Jun 30 05:22:12 2016 +0100
@@ -0,0 +1,45 @@
+---
+labels:
+- 'Type-Storage'
+- 'Stage-Alpha'
+summary: MU-Conference SQL Read-only Storage Module
+...
+
+Introduction
+============
+
+This is a storage backend using MU-Conference’s SQL storage. It depends
+on [LuaDBI](https://prosody.im/doc/depends#luadbi)
+
+This module only works in read-only, and was made to be used by
+[mod\_migrate](https://modules.prosody.im/mod_migrate.html) to migrate
+from MU-Conference’s SQL storage.
+
+You may need to convert your 'rooms' and 'rooms\_lists' tables to
+utf8mb4 before running that script, in order not to end up with
+mojibake.  Note that MySQL doesn’t support having more than
+191 characters in the jid field in this case, so you may have to change
+the table schema as well.
+
+Configuration
+=============
+
+Copy the module to the prosody modules/plugins directory.
+
+In Prosody's configuration file, set:
+
+    storage = "muconference_readonly"
+
+MUConferenceSQL options are the same as the
+[https://prosody.im/doc/modules/mod\_storage\_sql](SQL ones):
+
+Compatibility
+=============
+
+  ------- ---------------------------
+  trunk   Works
+  ------- ---------------------------
+  0.10    Untested, but should work
+  ------- ---------------------------
+  0.9     Does not work
+  ------- ---------------------------