aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/generators/rails/mailer/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/generators/rails/mailer/USAGE')
-rw-r--r--railties/lib/generators/rails/mailer/USAGE15
1 files changed, 15 insertions, 0 deletions
diff --git a/railties/lib/generators/rails/mailer/USAGE b/railties/lib/generators/rails/mailer/USAGE
new file mode 100644
index 0000000000..4b0b8ddc3b
--- /dev/null
+++ b/railties/lib/generators/rails/mailer/USAGE
@@ -0,0 +1,15 @@
+Description:
+ Stubs out a new mailer and its views. Pass the mailer name, either
+ CamelCased or under_scored, and an optional list of emails as arguments.
+
+ This generates a mailer class in app/models and invokes your template
+ engine and test framework generators.
+
+Example:
+ `./script/generate mailer Notifications signup forgot_password invoice`
+
+ creates a Notifications mailer class, views, test, and fixtures:
+ Mailer: app/mailers/notifications.rb
+ Views: app/views/notifications/signup.erb [...]
+ Test: test/functional/notifications_test.rb
+ Fixtures: test/fixtures/notifications/signup [...]