diff options
| author | Sean Griffin <sean@seantheprogrammer.com> | 2015-12-23 16:17:36 -0700 |
|---|---|---|
| committer | Sean Griffin <sean@seantheprogrammer.com> | 2015-12-23 16:17:36 -0700 |
| commit | c9b36dd67a1c8fe40ad76301e3929e47b0b23e1d (patch) | |
| tree | 03609a54255e77d7186063add465c7e3337db29b /railties | |
| parent | 435ebf456984f2e3f051ceef8aa9a1b1f2b918ce (diff) | |
| parent | c2534378f12264088249c48aaaa0d6887ad51bda (diff) | |
| download | rails-c9b36dd67a1c8fe40ad76301e3929e47b0b23e1d.tar.gz rails-c9b36dd67a1c8fe40ad76301e3929e47b0b23e1d.tar.bz2 rails-c9b36dd67a1c8fe40ad76301e3929e47b0b23e1d.zip | |
Merge pull request #22750 from nettofarah/patch-1
Plugin Usage and Installation instructions
Diffstat (limited to 'railties')
| -rw-r--r-- | railties/lib/rails/generators/rails/plugin/templates/README.md | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/railties/lib/rails/generators/rails/plugin/templates/README.md b/railties/lib/rails/generators/rails/plugin/templates/README.md index 61ad1ed36a..9d2b74416e 100644 --- a/railties/lib/rails/generators/rails/plugin/templates/README.md +++ b/railties/lib/rails/generators/rails/plugin/templates/README.md @@ -1,3 +1,28 @@ # <%= camelized_modules %> +Short description and motivation. -This project rocks and uses MIT-LICENSE. +## Usage +How to use my plugin. + +## Installation +Add this line to your application's Gemfile: + +```ruby +gem '<%= name %>' +``` + +And then execute: +```bash +$ bundle +``` + +Or install it yourself as: +```bash +$ gem install <%= name %> +``` + +## Contributing +Contribution directions go here. + +## License +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). |