# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1443724994 -7200
# Node ID 3483381c5e465a41598422b56ff7da59dcd094e2
# Parent  a7fdab9c14e2dbe4461aece5bb346734b4d809bd
mod_auth_http_async: Add README

diff -r a7fdab9c14e2 -r 3483381c5e46 mod_auth_http_async/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_http_async/README.markdown	Thu Oct 01 20:43:14 2015 +0200
@@ -0,0 +1,22 @@
+Introduction
+============
+
+This is an experimental authentication module that does an asynchronous
+HTTP call to verify username and password.
+
+Details
+=======
+
+When a user attempts to authenticate to Prosody, this module takes the
+username and password and does a HTTP GET request with [Basic
+authentication][rfc7617] to the configured `http_auth_url`.
+
+Configuration
+=============
+
+``` {.lua}
+VirtualHost "example.com"
+authentication = "http_async"
+http_auth_url = "http://example.com/auth"
+```
+