Diff

mod_cloud_notify/README.markdown @ 1783:b31fe2d22310

mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included)
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 23:09:58 +0200
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_cloud_notify/README.markdown	Mon Aug 24 23:09:58 2015 +0200
@@ -0,0 +1,29 @@
+#summary XEP-0357: Cloud push notifications
+#labels Stage-Alpha
+
+= Introduction =
+
+This is an implementation of the server bits of
+[http://xmpp.org/extensions/xep-357.html XEP-357: Push].
+It allows clients to register an "app server" which is notified about
+new messages while the user is offline or disconnected.  Implementation
+of the "app server", which is expected to forward notifications to
+something like Google Cloud Messaging or Apple Notification Service.
+
+= Details =
+
+App servers are notified about offline messages.
+
+= Installation =
+
+Same as any other module.
+
+= Configuration =
+
+Configured in-band by supporting clients.
+
+= Future =
+
+Adding support for sending notifications for users who are online but
+not currently connected, such as when `mod_smacks` is keeping their
+session alive, should be added.