# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1443713243 -7200
# Node ID e502c05c06083c4cfb325c772433e3a6803c8c10
# Parent  b42eb10dc7d237d2bc9d894b3bb5f4cdd03589c1
mod_storage_multi: Add README

diff -r b42eb10dc7d2 -r e502c05c0608 mod_storage_multi/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_multi/README.markdown	Thu Oct 01 17:27:23 2015 +0200
@@ -0,0 +1,34 @@
+---
+summary: Multi-backend storage module (WIP)
+labels:
+- NeedDocs
+...
+
+Introduction
+============
+
+This module attemtps to provide a storage driver that is really multiple
+storage drivers. This could be used for storage error tolerance or
+caching of data in a faster storage driver.
+
+Configuration
+=============
+
+An example:
+
+``` {.lua}
+storage = "multi"
+storage_multi_policy = "all"
+storage_multi = {
+    "memory",
+    "internal",
+    "sql"
+}
+```
+
+Here data would be first read from or written to [mod\_storage\_memory],
+then internal storage, then SQL storage. For reads, the first successful
+read will be used. For writes, it depends on the `storage_multi_policy`
+option. If set to `"all"`, then all storage backends must report success
+for the write to be considered successful. Other options are `"one"` and
+`"majority"`.