aboutsummaryrefslogtreecommitdiffstats
path: root/actionmailer/lib/rails/generators/mailer/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'actionmailer/lib/rails/generators/mailer/USAGE')
-rw-r--r--actionmailer/lib/rails/generators/mailer/USAGE17
1 files changed, 17 insertions, 0 deletions
diff --git a/actionmailer/lib/rails/generators/mailer/USAGE b/actionmailer/lib/rails/generators/mailer/USAGE
new file mode 100644
index 0000000000..2b0a078109
--- /dev/null
+++ b/actionmailer/lib/rails/generators/mailer/USAGE
@@ -0,0 +1,17 @@
+Description:
+============
+ Stubs out a new mailer and its views. Passes the mailer name, either
+ CamelCased or under_scored, and an optional list of emails as arguments.
+
+ This generates a mailer class in app/mailers and invokes your template
+ engine and test framework generators.
+
+Example:
+========
+ rails generate mailer Notifications signup forgot_password invoice
+
+ creates a Notifications mailer class, views, and test:
+ Mailer: app/mailers/notifications_mailer.rb
+ Views: app/views/notifications_mailer/signup.text.erb [...]
+ Test: test/mailers/notifications_mailer_test.rb
+