mod_readonly: Add a stub README
authorKim Alvefur <zash@zash.se>
Mon, 07 Jan 2019 20:07:57 +0100
changeset 3441 ce5d1fa69ba3
parent 3440 12c7c0d7e1b0
child 3442 b74c86d137c9
mod_readonly: Add a stub README
mod_readonly/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_readonly/README.markdown	Mon Jan 07 20:07:57 2019 +0100
@@ -0,0 +1,9 @@
+This module blocks configured queries that change server state.
+
+E.g. to make vCard storage read-only:
+
+``` lua
+readonly_stores = {
+	vcard = { "vcard-temp", "vCard" };
+}
+```