# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1523906511 -7200
# Node ID 693d16c18e2961897fd2df724995395ae585a59c
# Parent  ec2984aa53dbffd161b432c8e0bb89dc97c3ecef
mod_http_dir_listing2: Add README based the one from mod_http_dir_listing

diff -r ec2984aa53db -r 693d16c18e29 mod_http_dir_listing2/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_dir_listing2/README.markdown	Mon Apr 16 21:21:51 2018 +0200
@@ -0,0 +1,41 @@
+---
+summary: HTTP directory listing
+...
+
+Introduction
+============
+
+This module generates directory listings when invoked by
+`mod_http_files`. See [documentation on
+`mod_http_files`](http://prosody.im/doc/modules/mod_http_files).
+
+It uses the [`util.interpolation`][doc:developers:util:interpolation]
+template engine included with Prosody since 0.10.
+
+Configuration
+=============
+
+The module itself doesn't have any configuration of its own, just enable
+the it along with `mod_http_files`.
+
+    modules_enabled = {
+        ...
+
+        "http_files";
+        "http_dir_listing";
+    }
+
+    http_dir_listing = true;
+
+The layout, CSS and icons in the `resources/` directory can be
+customized or replaced. All resources are cached in memory when the
+module is loaded and the images are inlined in the CSS.
+
+Compatibility
+=============
+
+  ------- --------------
+  trunk   Works
+  0.10    Works
+  0.9     Doesn't work
+  ------- --------------