# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1522069260 -3600
# Node ID 0092bcceda0a33f6218eda4556df2b68cdc1f3e7
# Parent  e8462d6dbc6d62f8c30262df5ac3958251f80a4f
mod_component_http: Update README to include config snippet example

diff -r e8462d6dbc6d -r 0092bcceda0a mod_component_http/README.markdown
--- a/mod_component_http/README.markdown	Mon Mar 26 13:56:18 2018 +0100
+++ b/mod_component_http/README.markdown	Mon Mar 26 14:01:00 2018 +0100
@@ -34,6 +34,20 @@
 Configuration
 =============
 
+The module is quite flexible, but should generally be loaded as a component like this:
+
+```
+Component "yourservice.example.com" "component_http"
+  component_post_url = "https://example.com/your-api"
+```
+
+Such a component would handle traffic for all JIDs with 'yourservice.example.com' as the hostname, such
+as 'foobar@yourservice.example.com'. Although this example uses a subdomain, there is no requirement for
+the component to use a subdomain.
+
+Available configuration options are:
+
+
   Option                                 Description
   ------------------------------------   -------------------------------------------------------------------------------------------------------------------------------------------------
   component\_post\_url                   The URL that will handle incoming stanzas