diff mod_sms_free/README.markdown @ 3695:5a70dd2349a7

mod_sms_free: New module!
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sun, 06 Oct 2019 17:29:22 +0200
parents
children a07bd12fe554
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_sms_free/README.markdown	Sun Oct 06 17:29:22 2019 +0200
@@ -0,0 +1,38 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: XMPP to SMS gateway using the HTTP API provided by mobile.free.fr
+...
+
+Introduction
+============
+
+This module sends an SMS to your phone when you receive a message on XMPP when
+your status is xa or disconnected.
+
+Note that it doesn’t support sending SMS to anyone else than yourself, in that
+it is quite different from other gateways.
+
+Configuration
+=============
+
+In prosody.cfg.lua:
+
+    modules_enabled = {
+        "sms_free",
+    }
+
+Usage
+=====
+
+Every user who wants to use this gateway can issue an ad-hoc command to their
+server, then follow the instructions and start receiving messages by SMS when
+they are unavailable or xa.
+
+Compatibility
+=============
+
+  ----- -----------
+  trunk Works
+  0.11  Should work
+  ----- -----------