summaryrefslogtreecommitdiffstats
path: root/README.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.rdoc')
-rw-r--r--README.rdoc35
1 files changed, 30 insertions, 5 deletions
diff --git a/README.rdoc b/README.rdoc
index 08680cd..ee40adc 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -6,17 +6,29 @@ of the supported carriers.
== Supported Carriers (US & International):
-Alltel, Ameritech, AT&T, BellSouth Mobility, BlueSkyFrog, Boost Mobile, Cellular South,
-E-Plus, Fido, kajeet, Metro PCS, Powertel, PSC Wireless, Qwest, Southern Link, Sprint,
-Suncom, T-Mobile (US/UK/Germany), Telefonica, Virgin Mobile, Verizon Wireless,
-Vodafone (UK,Italy,Japan, Spain)
+Alltel, Ameritech, AT&T, Bell Atlantic, BellSouth Mobility, Beeline(UA), BlueSkyFrog,
+Boost Mobile, BPL Mobile, Cellular South, Claro (Brazil, Nicaragua), Comcast, Du,
+E-Plus, Etisalat, Fido, kajeet, Mobinil, Mobitel, Movistar, Metro PCS, O2, Orange,
+Powertel, PSC Wireless, Qwest, Rogers, Southern Link, Sprint, Suncom,
+T-Mobile (US/UK/Germany), Telefonica, Tracfone, Virgin Mobile, Verizon Wireless,
+Vodafone (UK, Egypt, Italy, Japan, Spain), and many more ...
+
+== Opt-In Warning for Some International Carriers
+
+Some International carriers require that their users subscribe to an Email to SMS
+feature before they are able to receive SMS messages this way. If one your users
+mentions that they are not receiving their messages, chances are it is due to this
+limitation.
+
+Some carriers that need this include, Mobitel, Etisalat, T-Mobile (Netherlands),
+etc.
== Setup Instructions
Add this this one line to the controller you want to be able to use SMS Fu in.
class ExampleController < ApplicationController
- include SMSFu
+ has_sms_fu
end
Modify sms_fu.yml in your config folder with your reply-to e-mail address.
@@ -60,5 +72,18 @@ That's it! Now you're good to go.
get_sms_address("5558675309","at&t") # => "5558675309@txt.att.net"
+== View Helpers
+
+* Retrieve a collection of all carriers
+
+ <%= carrier_collection %>
+
+* Display a select box with mobile carriers
+
+ <%= carrier_select %>
+
+* Display a custom select box with mobile carriers
+
+ <%= carrier_select('user[carrier_name]', "Please choose a carrier") %>
Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license