README.rdoc in cap_gun-0.0.1 vs README.rdoc in cap_gun-0.0.2
- old
+ new
@@ -4,17 +4,20 @@
Tell everyone about your releases! Send email notification after Capistrano deployments! Rule the world!
Drop your ActionMailer configuration information into your deploy.rb file, configure recipients for the deployment notifications, and setup the callback task.
-Setup and configuration are done entirely inside your deploy.rb file to KISS. Your emails are sent locally, from the box performing the deployment, but CapGun queries the server to grab the necessary release info.
+Setup and configuration are done entirely inside your deploy.rb file to keep it super simple. Your emails are sent locally from the box performing the deployment, but CapGun queries the server to grab the necessary release info.
-We include the Net::SMTP TLS hack inside as a vendored dependancy to allow super easy email sending without setting up an MTA.
+This even includes the Net::SMTP TLS hack inside as a vendored dependancy to allow super easy email sending without setting up an MTA.
== CONFIG
In your Capistrano config file (usually deploy.rb):
+ # require cap_gun (the path will depend on where you unpacked or if you are just using it as a gem)
+ require 'vendor/plugins/cap_gun/lib/cap_gun' # typical Rails vendor/plugins location
+
# setup action mailer with a hash of options
set :cap_gun_action_mailer_config, {
:address => "smtp.gmail.com",
:port => 587,
:user_name => "[YOUR_USERNAME]@gmail.com",