diff options
| -rw-r--r-- | README.rdoc | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/README.rdoc b/README.rdoc index 109c0a1..a5b6c4b 100644 --- a/README.rdoc +++ b/README.rdoc @@ -37,7 +37,7 @@ etc. * (Optional) Modify sms_fu.yml in your config folder with your reply-to e-mail address. -== Example Usage +== Numbers and Carriers * You have to send in the phone number, without any non-numeric characters. The phone numbers must be 10 digits in length. @@ -57,39 +57,39 @@ etc. * Check sms_fu.yml for a complete list of supported carriers, including international carriers as well. -* Configure and setup SMS Fu +== Configuration and Usage -*SMS Fu relies on either ActionMailer or Pony for delivery. You can now specify -which you'd like to use for delivery.* +* SMS Fu relies on either ActionMailer or Pony for delivery. You can now specify + which you'd like to use for delivery. -You can use your ActionMailer settings by just specifying the :delivery option as -:action_mailer. +* You can use your ActionMailer settings by just specifying the :delivery option as + :action_mailer. -If you would like to use Pony, you can configure it to use :sendmail or :smtp via -Pony. Set the :delivery option to :pony and then make sure to specify the -:pony_options as well, if necessary. +* If you would like to use Pony, you can configure it to use :sendmail or :smtp via + Pony. Set the :delivery option to :pony and then make sure to specify the + :pony_options as well, if necessary. - # ActionMailer delivery - sms_fu = SMSFu.configure(:delivery => :action_mailer) - - # Pony delivery via Sendmail - sms_fu = SMSFu.configure(:delivery => :pony, :pony_options => { :via => :sendmail }) - - # Pony delivery via SMTP - sms_fu = SMSFu.configure(:delivery => :pony, - :pony_options => { - :via => :smtp, - :via_options => { - :address => 'smtp.gmail.com', - :port => '587', - :user_name => 'username', - :password => 'password', - :authentication => :plain, - :domain => "localhost.localdomain" - :enable_starttls_auto => true, - }}) + # ActionMailer delivery + sms_fu = SMSFu.configure(:delivery => :action_mailer) + + # Pony delivery via Sendmail + sms_fu = SMSFu.configure(:delivery => :pony, :pony_options => { :via => :sendmail }) + + # Pony delivery via SMTP + sms_fu = SMSFu.configure(:delivery => :pony, + :pony_options => { + :via => :smtp, + :via_options => { + :address => 'smtp.gmail.com', + :port => '587', + :user_name => 'username', + :password => 'password', + :authentication => :plain, + :domain => "localhost.localdomain" + :enable_starttls_auto => true, + }}) -You can view more pony 'via_options' at http://github.com/benprew/pony +* You can view more pony 'via_options' at http://github.com/benprew/pony * Basic delivery |