aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails_generator/generators/components/plugin/USAGE
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2005-10-28 16:33:25 +0000
committerDavid Heinemeier Hansson <david@loudthinking.com>2005-10-28 16:33:25 +0000
commit66bbc4f4e61a384a0bdb6aa0ba48f5641278db30 (patch)
tree7860f8baae114f34715ff382694f060d0a9bb0d2 /railties/lib/rails_generator/generators/components/plugin/USAGE
parentd5e48ae7d278cb6e03bef104eac23ac5cad46c5a (diff)
downloadrails-66bbc4f4e61a384a0bdb6aa0ba48f5641278db30.tar.gz
rails-66bbc4f4e61a384a0bdb6aa0ba48f5641278db30.tar.bz2
rails-66bbc4f4e61a384a0bdb6aa0ba48f5641278db30.zip
Added plugin generator to create a stub structure for a new plugin in vendor/plugins (see "script/generate plugin" for help) [DHH]
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2784 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'railties/lib/rails_generator/generators/components/plugin/USAGE')
-rw-r--r--railties/lib/rails_generator/generators/components/plugin/USAGE18
1 files changed, 18 insertions, 0 deletions
diff --git a/railties/lib/rails_generator/generators/components/plugin/USAGE b/railties/lib/rails_generator/generators/components/plugin/USAGE
new file mode 100644
index 0000000000..55e35be595
--- /dev/null
+++ b/railties/lib/rails_generator/generators/components/plugin/USAGE
@@ -0,0 +1,18 @@
+Description:
+ The plugin generator creates stubs for a new plugin.
+
+ The generator takes a plugin name as its argument. The plugin name may be
+ given in CamelCase or under_score and should not be suffixed with 'Plugin'.
+
+ The generator creates a plugin directory in vendor/plugins that includes
+ both init.rb and README files as well as lib, task, and test directories.
+
+Example:
+ ./script/generate plugin BrowserFilters
+
+ This will create:
+ vendor/plugins/browser_filters/README
+ vendor/plugins/browser_filters/init.rb
+ vendor/plugins/browser_filters/lib/browser_filters.rb
+ vendor/plugins/browser_filters/test/browser_filters_test.rb
+ vendor/plugins/browser_filters/tasks/browser_filters_tasks.rake \ No newline at end of file