Adding in kajeet to carrier list and updated README

4 files changed, 61 insertions, 63 deletions

diff --git a/README b/README
deleted file mode 100644
index 13692c3..0000000
--- a/README
+++ /dev/null
@@ -1,62 +0,0 @@
-SMS Fu
-------------------
-
-  Allows you to send an SMS in the form of an e-mail to a cell phone.
-
-  Supported Carriers (US & International): 
-  Alltel, Ameritech, AT&T, BellSouth Mobility, BlueSkyFrog, Boost Mobile, Cellular South,
-  Fido, Metro PCS, PSC Wireless, Qwest, Southern Link, Sprint, Suncom, T-Mobile (US/UK/Germany), 
-  Virgin Mobile, Verizon Wireless, Vodafone (UK,Italy,Japan)
-
-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 some of the default carrier values:
-		
-    Alltel Wireless   =>  "alltel"
-    AT&T/Cingular     =>  "at&t"
-    Boost Mobile      =>  "boost"
-    Sprint Wireless   =>  "sprint"
-    T-Mobile US       =>  "t-mobile"
-    T-Mobile UK       =>  "t-mobile-uk"
-    Virgin Mobile     =>  "virgin"
-    Verizon Wireless  =>  "verizon"
-    Vodafone Tokyo		=>  "vodafone-jp-tokyo"
-
-	* Check sms_fu.yml for a complete list of supported carriers, including international
-    carriers as well.  Feel free to add your own carriers as well.
-		
-    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
diff --git a/README.rdoc b/README.rdoc
new file mode 100644
index 0000000..94f0c9b
--- /dev/null
+++ b/README.rdoc
@@ -0,0 +1,59 @@
+= SMS Fu
+
+Want to send an SMS from your Rails application?  SMS Fu allows you to do just that.  
+It allows you to send a text-message in the form of an e-mail to a cell phone on any
+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)
+
+== 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
+    end
+
+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 some of the default carrier values:
+		
+  Alltel Wireless   =>  "alltel"
+  AT&T/Cingular     =>  "at&t"
+  Boost Mobile      =>  "boost"
+  Sprint Wireless   =>  "sprint"
+  T-Mobile US       =>  "t-mobile"
+  T-Mobile UK       =>  "t-mobile-uk"
+  Virgin Mobile     =>  "virgin"
+  Verizon Wireless  =>  "verizon"
+  Vodafone Tokyo		=>  "vodafone-jp-tokyo"
+
+* <b>Check sms_fu.yml for a complete list of supported carriers, including international
+  carriers as well.</b>
+		
+    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") # => "5558675309@txt.att.net"
+
+		
+Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license
diff --git a/install.rb b/install.rb
index 20fd849..73695a6 100644
--- a/install.rb
+++ b/install.rb
@@ -1,4 +1,4 @@
 require 'ftools'
 require 'fileutils'
-puts IO.read(File.join(File.dirname(__FILE__), 'README'))
+puts IO.read(File.join(File.dirname(__FILE__), 'README.rdoc'))
 File.copy(File.dirname(__FILE__)+'/templates/sms_fu.yml', File.dirname(__FILE__)+'/../../../config')
\ No newline at end of file
diff --git a/templates/sms_fu.yml b/templates/sms_fu.yml
index 8c93ebd..bacd37d 100644
--- a/templates/sms_fu.yml
+++ b/templates/sms_fu.yml
@@ -10,6 +10,7 @@ carriers:
   blueskyfrog: @blueskyfrog.com
   boost: @myboostmobile.com
   cellularsouth: @csouth1.com
+  kajeet: @mobile.kajeet.net
   metropcs: @mymetropcs.com
   powertel: @ptel.net
   pscwireless: @sms.pscel.com