diff options
Diffstat (limited to 'railties/lib/rails_generator/generators/components/plugin')
| -rw-r--r-- | railties/lib/rails_generator/generators/components/plugin/USAGE | 26 |
1 files changed, 8 insertions, 18 deletions
diff --git a/railties/lib/rails_generator/generators/components/plugin/USAGE b/railties/lib/rails_generator/generators/components/plugin/USAGE index f033c81442..d2ecfc2d59 100644 --- a/railties/lib/rails_generator/generators/components/plugin/USAGE +++ b/railties/lib/rails_generator/generators/components/plugin/USAGE @@ -1,19 +1,15 @@ Description: - The plugin generator creates stubs for a new plugin. + Stubs out a new plugin. Pass the plugin name, either CamelCased or + under_scored, as an argument. Pass --with-generator to add an example + generator also. - 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. - - It's also possible to generate stub files for a generator to go with the - plugin by using --with-generator + This creates a plugin in vendor/plugins including an init.rb and README + as well as standard lib, task, and test directories. Example: - ./script/generate plugin BrowserFilters + `./script/generate plugin BrowserFilters` - This will create: + creates a standard browser_filters plugin: vendor/plugins/browser_filters/README vendor/plugins/browser_filters/init.rb vendor/plugins/browser_filters/install.rb @@ -23,13 +19,7 @@ Example: ./script/generate plugin BrowserFilters --with-generator - This will create: - vendor/plugins/browser_filters/README - vendor/plugins/browser_filters/init.rb - vendor/plugins/browser_filters/install.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 + creates a browser_filters generator also: vendor/plugins/browser_filters/generators/browser_filters/browser_filters_generator.rb vendor/plugins/browser_filters/generators/browser_filters/USAGE vendor/plugins/browser_filters/generators/browser_filters/templates/ |