# HG changeset patch
# User phil.stewart@gmail.com
# Date 1301867635 0
# Node ID 2830f393c1937ab01c808633a16e99268f7ca231
# Parent  8426db59abf0877963fecf0641e568b8ffe8c718
mod_sms_clickatell: Update wiki to reflect changes to component config and registration


diff -r 8426db59abf0 -r 2830f393c193 mod_sms_clickatell.wiki
--- a/mod_sms_clickatell.wiki	Sat Apr 02 06:15:02 2011 +0500
+++ b/mod_sms_clickatell.wiki	Sun Apr 03 21:53:55 2011 +0000
@@ -11,21 +11,16 @@
 
 {{{
 Component "sms.example.com" "sms_clickatell"
-	clickatell_api_id = [api id]
-	sms_source_number = [source number]
 	sms_message_prefix = "some text"
 }}}
 
-The clickatell_api_id is a number which is your Clickatell HTTP API ID. In future this will likely be migrated out of config in to component
-registration.
-
-The sms_source_number is the mobile number you want messages to 'originate' from i.e. where your recipients see messages coming from. This should really be per-user configurable, so again will be moved tp component registration in future. The number should be in international format without leading plus sign, or you can use some other format if clickatell supports it.
-
 The sms_message_prefix is a piece of text you want prefixing to all messages sent through the gateway. For example, I use the prefix "[Via XMPP] " to indicate to recipients that I've sent the message via the internet rather than the mobile network. Since my primary use case for this component is to be able to send messages to people only reachable via mobile when I myself only have internet access and no mobile reception, this option allows me to give a hint to my recipients that any reply they send may not reach me in a timely manner.
 
 = Usage =
 
-Once you've installed and configured, you should be able to use service discovery in your XMPP client to find the component service. Once found, you need to register with the service, supplying your Clickatell username and password (in future service registration will also include the API ID and the source number).
+Once you've installed and configured, you should be able to use service discovery in your XMPP client to find the component service. Once found, you need to register with the service, supplying your Clickatell username, password, API ID, and a source number for your text messages.
+
+The source number is the mobile number you want messages to 'originate' from i.e. where your recipients see messages coming from. The number should be in international format without leading plus sign, or you can use some other format if clickatell supports it.
 
 To send text messages to a target number, you need to add a contact in the form of [number]@sms.example.com, where [number] is the mobile number of the recipient, in international format without leading plus sign, and sms.example.com is the name for the component you configured above. For example:
 
@@ -39,4 +34,4 @@
 
 = Todo =
 
-  * Move API ID and sms source number out of config and in to component registration
\ No newline at end of file
+  * Refactor to create a framework for multiple sms gateway back ends, and split Clickatell specific code in to its own back end
\ No newline at end of file