# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1673366820 0
# Node ID 4511e90d1d0864b476a2493dd3b9b4f82ae4bb33
# Parent  471cbb583a1d24a2d67345e17b2c9a0ef06d730d
mod_unified_push: README: Documentation updates (example, etc.)

diff -r 471cbb583a1d -r 4511e90d1d08 mod_unified_push/README.md
--- a/mod_unified_push/README.md	Tue Jan 10 15:45:25 2023 +0000
+++ b/mod_unified_push/README.md	Tue Jan 10 16:07:00 2023 +0000
@@ -7,8 +7,15 @@
 This module implements a [Unified Push](https://unifiedpush.org/) Provider
 that uses XMPP to talk to a Push Distributor (e.g. [Conversations](http://codeberg.org/iNPUTmice/Conversations)).
 
-For a server-independent external component, or details about the protocol,
-see [the 'up' project](https://codeberg.org/inputmice/up).
+It allows push notifications to be delivered to apps on your device over XMPP.
+This means notifications can be delivered quickly and efficiently (apps don't
+need to repeatedly poll for new notifications).
+
+For a list of compatible apps, see the [UnifiedPush apps list](https://unifiedpush.org/users/apps/).
+
+A server-independent external component is also available - see [the 'up'
+project](https://codeberg.org/inputmice/up). That project also contains a
+description of the protocol between the XMPP server and the client.
 
 This module and the protocol it implements is at an experimental prototype
 stage.
@@ -28,6 +35,25 @@
 `openssl rand -base64 32`. Changing the secret will invalidate all existing
 push registrations.
 
+This module exposes a HTTP endpoint (to receive push notifications from app
+servers). For more information on configuring HTTP services in Prosody, see
+[Prosody HTTP documentation](https://prosody.im/doc/http).
+
+### Example configuration
+
+This example creates a push notification component called
+'notify.example.com'.
+
+The 'http_host' line instructs Prosody to expose this module's HTTP services
+on the 'example.com' host, which avoids needing to create/update DNS records
+and HTTPS certificates if example.com is already set up.
+
+``` {.lua}
+Component "notify.example.com" "unified_push"
+    unified_push_secret = "<secret string here>"
+    http_host = "example.com"
+```
+
 ## Compatibility
 
 Requires Prosody trunk (not compatible with 0.12).