Diff

--- a/mod_smacks/README.md	Wed Oct 23 14:55:17 2024 +0200
+++ b/mod_smacks/README.md	Sun Oct 27 13:14:25 2024 +0100
@@ -6,84 +6,3 @@
 ...
 
 Since Prosody 0.12, this module is [included in Prosody](https://prosody.im/doc/modules/mod_smacks).
-
-#Introduction
-
-By default XMPP is as reliable as your network is. Unfortunately in some
-cases that is not very reliable - in some network conditions disconnects
-can be frequent and message loss can occur.
-
-To overcome this, XMPP has an optional extension (XEP-0198: Stream
-Management) which, when supported by both the client and server, can
-allow a client to resume a disconnected session, and prevent message
-loss.
-
-#Details
-
-When using XEP-0198 both the client and the server keep a queue of the
-most recently sent stanzas - this is cleared when the other end
-acknowledges they have received the stanzas. If the client disconnects,
-instead of marking the user offline the server pretends the client is
-still online for a short (configurable) period of time. If the client
-reconnects within this period, any stanzas in the queue that the client
-did not receive are re-sent.
-
-If the client fails to reconnect before the timeout it will be marked as
-offline like prosody does on disconnect without mod_smacks.
-If the client is the last one for this jid, all message stanzas are added to
-the offline store and all other stanzas stanzas are returned with an
-"recipient-unavailable" error. If the client is not the last one with an
-open smacks session, *all* stanzas are returned with an "recipient-unavailable" error.
-
-If you deliberately disabled [mod_offline], all message stanzas of the last client
-are also returned with an "recipient-unavailable" error, because the can not be
-added to the offline storage.
-If you don't want this behaviour you can use [mod_nooffline_noerror] to suppress the error.
-This is generally only advisable, if you are sure that all your clients are using MAM!
-
-This module also provides some events used by [mod_cloud_notify].
-These events are: "smacks-ack-delayed", "smacks-hibernation-start" and
-"smacks-hibernation-end". See [mod_cloud_notify] for details on how this
-events are used there.
-
-Use prosody 0.10+ to have per user limits on allowed sessions in hibernation
-state and allowed sessions for which the h-value is kept even after the
-hibernation timed out.
-These are settable using `smacks_max_hibernated_sessions` and `smacks_max_old_sessions`.
-
-#Configuration
-
-  Option                              Default           Description
-  ----------------------------------  ----------------- ------------------------------------------------------------------------------------------------------------------
-  `smacks_hibernation_time`           600 (10 minutes)  The number of seconds a disconnected session should stay alive for (to allow reconnect)
-  `smacks_enabled_s2s`                true              Enable Stream Management on server connections? *Experimental*
-  `smacks_s2s_resend`                 false             Attempt to re-send unacked messages on s2s disconnect *Experimental*
-  `smacks_max_unacked_stanzas`        0                 How many stanzas to send before requesting acknowledgement
-  `smacks_max_ack_delay`              30 (1/2 minute)   The number of seconds an ack must be unanswered to trigger an "smacks-ack-delayed" event
-  `smacks_max_hibernated_sessions`    10                The number of allowed sessions in hibernated state (limited per user)
-  `smacks_max_old_sessions`           10                The number of allowed sessions with timed out hibernation for which the h-value is still kept (limited per user)
-
-#Compatibility
-
-  ------- -------
-  trunk   Works
-  0.11    Works
-  ------- -------
-
-
-#Clients
-
-Clients that support [XEP-0198]:
-
--   Gajim (Linux, Windows, OS X)
--   Conversations (Android)
--   ChatSecure (iOS)
--   Swift (but not resumption, as of version 2.0 and alphas of 3.0)
--   Psi (in an unreleased branch)
--   Yaxim (Android)
--   Monal (iOS)
-
-[7693724881b3]: //hg.prosody.im/prosody-modules/raw-file/7693724881b3/mod_smacks/mod_smacks.lua
-[mod_offline]: //modules.prosody.im/mod_offline
-[mod_nooffline_noerror]: //modules.prosody.im/mod_nooffline_noerror
-[mod_cloud_notify]: //modules.prosody.im/mod_cloud_notify