aboutsummaryrefslogtreecommitdiffstats
path: root/lib/generators/rails/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'lib/generators/rails/USAGE')
-rw-r--r--lib/generators/rails/USAGE12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/generators/rails/USAGE b/lib/generators/rails/USAGE
new file mode 100644
index 0000000000..d679dd63ae
--- /dev/null
+++ b/lib/generators/rails/USAGE
@@ -0,0 +1,12 @@
+Description:
+============
+ Stubs out a new mailbox class in app/mailboxes and invokes your template
+ engine and test framework generators.
+
+Example:
+========
+ rails generate mailbox inbox
+
+ creates a InboxMailbox class and test:
+ Mailbox: app/mailboxes/inbox_mailbox.rb
+ Test: test/mailboxes/inbox_mailbox_test.rb