diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 56 |
1 files changed, 56 insertions, 0 deletions
@@ -0,0 +1,56 @@ +SMS Fu (0.2) +------------- + + Allows you to send an SMS in the form of an e-mail to a cell phone. Only + numbers in the United States are supported. + + Supported Carriers: + Alltel, AT&T, Boost Mobile, Sprint, T-Mobile, Virgin Mobile, Verizon Wireless + +Setup Instructions +------------------ + + **** IMPORTANT **** + + 1) Add this this one line to the controller you want to be able to use SMSFu in. + + class ExampleController < ApplicationController + include SMSFu + end + + 2) Modify sms_fu.yml in your config folder with your reply-to e-mail address. + + That's it! Now you're good to go. + +Example Usage +------------- + + * You have to send in the phone number, without any non-numeric characters. The + phone numbers must be 10 digits in length. + * The two required parameters are the phone number and the phone carrier. + * Here are the carrier values: + + Alltel Wireless => "Alltel" + AT&T/Cingular => "AT&T" + Boost Mobile => "Boost" + Sprint Wireless => "Sprint" + T-Mobile => "T-Mobile" + Virgin Mobile => "Virgin" + Verizon Wireless => "Verizon" + + deliver_sms("5558675309","AT&T","your message here") + + * You can set the maximum length of the SMS message, which is not set by + default. Most phones can only accept 128 characters. To do this just + specify the limit option. + + deliver_sms("5558675309","AT&T","your message here", :limit => 128) + + * You can retrieve just the formatted address to use in your own mailer. + + get_sms_address("5558675309","AT&T") + + This returns "5558675309@txt.att.net" + + +Copyright (c) 2008 Brendan G. Lim, released under the MIT license |