changeset 3437:ce5d1fa69ba3

mod_readonly: Add a stub README
author Kim Alvefur <zash@zash.se>
date Mon, 07 Jan 2019 20:07:57 +0100
parents 12c7c0d7e1b0
children b74c86d137c9
files mod_readonly/README.markdown
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /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" };
+}
+```