# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1441319348 -7200
# Node ID 318f38d79ea98ddf7b7a0f7f37190cd2643b0fae
# Parent  9376e870f0e18889c7985c2f40d5ce2cf4b1485e
mod_http_index: Add README file

diff -r 9376e870f0e1 -r 318f38d79ea9 mod_http_index/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_index/README.markdown	Fri Sep 04 00:29:08 2015 +0200
@@ -0,0 +1,24 @@
+Introduction
+============
+
+This module produces a list of enabled HTTP "apps" exposed from Prosody
+at `http://example.org:5280/`, e.g. mod\_http\_muc\_log,
+mod\_http\_files or mod\_admin\_web. If you think Prosodys default
+"root" web page (a 404 error usually) is boring, this might be the
+module for you! :)
+
+Configuration
+=============
+
+Install and enable like any other module. Also see [Prosodys HTTP
+documentation](https://prosody.im/doc/http).
+
+``` {.lua}
+modules_enabled = {
+  -- other modules
+  "http_index";
+}
+
+-- optional, defaults to a file next to the module
+http_index_template = "/path/to/template.html"
+```