modules/SMSPlug/README.txt

// $Id:$

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Features
 * Requirements
 * Installation & Upgrading
 * Settings
 * Maintainers


INTRODUCTION
------------

The SMSPlug module allows users to send sms from their community site. The administrator
can define, how many sms each user can send per month.

FEATURES
--------

 * Interacts with Profile module.
 * Logs information per each user.

REQUIREMENTS
------------

The SMSPlug module requires the Profile module which is a Core module that
comes with Drupal. It requires you to make a field of the type 'textfield' and 
with the name 'profile_handynumber'. 


INSTALLATION & UPGRADING
------------------------

See INSTALL.txt for install/upgrade instructions.


SETTINGS
--------

Setting the module is done on a number of pages.

  SMSPlug administration pages
  ------------------------------
  The SMSPlug administration pages (?q=admin/settings/smsplug) is where the
  actual features of the SMSPlug module are set. Some of the options are
  described below.
  * 'Number of SMS per month': here you can select how many sms each user can send
  * 'Originator': the default is the domain name of the drupal installation, this 
    is displayed instead of a number
  * 'Userkey': this key is provided by aspsms.com
  * 'Password': this is the password which you use to access aspsms.com
  * 'SMSPlug log settings': here you can define what should be logged.

  Permissions
  -----------
  To allow users to view SMSPlug, the 'access smsplug'
  permission needs to be set for the appropiate role. This allows them to
  see activated blocks with SMSPlug form.


MAINTAINERS
-----------

 * Marco Bischoff (marco_b) - http://drupal.org/user/491194
1	// $Id:$
2
3	CONTENTS OF THIS FILE
4	---------------------
5
6	* Introduction
7	* Features
8	* Requirements
9	* Installation & Upgrading
10	* Settings
11	* Maintainers
12
13
14	INTRODUCTION
15	------------
16
17	The SMSPlug module allows users to send sms from their community site. The administrator
18	can define, how many sms each user can send per month.
19
20	FEATURES
21	--------
22
23	* Interacts with Profile module.
24	* Logs information per each user.
25
26	REQUIREMENTS
27	------------
28
29	The SMSPlug module requires the Profile module which is a Core module that
30	comes with Drupal. It requires you to make a field of the type 'textfield' and
31	with the name 'profile_handynumber'.
32
33
34	INSTALLATION & UPGRADING
35	------------------------
36
37	See INSTALL.txt for install/upgrade instructions.
38
39
40	SETTINGS
41	--------
42
43	Setting the module is done on a number of pages.
44
45	SMSPlug administration pages
46	------------------------------
47	The SMSPlug administration pages (?q=admin/settings/smsplug) is where the
48	actual features of the SMSPlug module are set. Some of the options are
49	described below.
50	* 'Number of SMS per month': here you can select how many sms each user can send
51	* 'Originator': the default is the domain name of the drupal installation, this
52	is displayed instead of a number
53	* 'Userkey': this key is provided by aspsms.com
54	* 'Password': this is the password which you use to access aspsms.com
55	* 'SMSPlug log settings': here you can define what should be logged.
56
57	Permissions
58	-----------
59	To allow users to view SMSPlug, the 'access smsplug'
60	permission needs to be set for the appropiate role. This allows them to
61	see activated blocks with SMSPlug form.
62
63
64	MAINTAINERS
65	-----------
66
67	* Marco Bischoff (marco_b) - http://drupal.org/user/491194