mod_http_favicon/README.markdown
changeset 1807 4d73a1a6ba68
parent 1786 29f3d6b7ad16
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_favicon/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,31 @@
+---
+summary: HTTP favicon
+...
+
+Introduction
+============
+
+This simple module serves a `favicon.ico` from prosodys HTTP server and
+nothing else.
+
+Configuring
+===========
+
+Simply load the module. The icon can be replaced by adding a `favicon`
+option to the config.
+
+    modules_enabled = {
+        ...
+        "favicon";
+    }
+
+    favicon = "/path/to/my-favicon.ico" -- Override the built in one
+
+Compatibility
+=============
+
+  ------- --------------
+  trunk   Works
+  0.9     Works
+  0.8     Doesn't work
+  ------- --------------