# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1756841521 -7200
# Node ID 7b693a5539add5f500381734cf7e008965d1d1c6
# Parent  8f2de66529309b6035ef15e99ec41ce90848b1c7
mod_auth_http_async: Update documentation

The required async APIs were included in 0.10.0, but at the time of this
writing we only consider 0.12.x and later supported.

The fallback sync API would have made it work with even earlier
versions, but I don't remember specifically and it doesn't matter.

diff -r 8f2de6652930 -r 7b693a5539ad mod_auth_http_async/README.md
--- a/mod_auth_http_async/README.md	Mon Aug 18 08:42:34 2025 -0400
+++ b/mod_auth_http_async/README.md	Tue Sep 02 21:32:01 2025 +0200
@@ -6,7 +6,7 @@
 Introduction
 ============
 
-This is an experimental authentication module that does an asynchronous
+This is an authentication module that does an asynchronous
 HTTP call to verify username and password.
 
 Details
@@ -19,6 +19,11 @@
 Configuration
 =============
 
+After installing, enable the module by setting `authentication` to `"http_async"`.
+
+The only setting is `http_auth_url` which should contain the URL endpoint where the authentication query is sent to. It can contain `$host` and
+`$user` which are substituted for the current VirtualHost and the authenticating username, respectively.
+
 ``` lua
 VirtualHost "example.com"
 authentication = "http_async"
@@ -28,4 +33,4 @@
 Compatibility
 =============
 
-Requires Prosody trunk
+Should work with Prosody 0.10.x and later.