# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1546766836 -3600
# Node ID a6722a35f35eec4eca7b8f6bfb77261fcfbc9d96
# Parent  213679266dcb270bd0da239cad4434f61858659e
mod_storage_xmlarchive: Expand description in README

diff -r 213679266dcb -r a6722a35f35e mod_storage_xmlarchive/README.markdown
--- a/mod_storage_xmlarchive/README.markdown	Sun Jan 06 10:26:32 2019 +0100
+++ b/mod_storage_xmlarchive/README.markdown	Sun Jan 06 10:27:16 2019 +0100
@@ -10,7 +10,12 @@
 ============
 
 This module implements stanza archives using files, similar to the
-default "internal" storage.
+default "internal" storage. Unlike "internal", it saves messages in two
+files per day (and per user), one containing metadata and one containing
+the actual messages in XML format (hence the name).
+
+Splitting data per day improves performance for larger archives as it
+does not have to look through data from other days.
 
 Configuration
 =============
@@ -87,3 +92,8 @@
 
 Each archive ID is of the form `YYYY-MM-DD-random`, making lookups by
 archive id just as simple as time based queries.
+
+## Limitations
+
+-   Only XML stanzas can be stored.
+-   The deletion method only supports removing entire days at a time.