diff options
| author | Netto Farah <nettofarah@gmail.com> | 2015-12-21 20:56:07 -0800 |
|---|---|---|
| committer | Netto Farah <nettofarah@gmail.com> | 2015-12-23 09:42:39 -0800 |
| commit | c2534378f12264088249c48aaaa0d6887ad51bda (patch) | |
| tree | 7ead3c60736f5ff9ac08f365a236d907d772093b /railties | |
| parent | 17a4e450489a785af53d3e11f5a35ec1e8ea0903 (diff) | |
| download | rails-c2534378f12264088249c48aaaa0d6887ad51bda.tar.gz rails-c2534378f12264088249c48aaaa0d6887ad51bda.tar.bz2 rails-c2534378f12264088249c48aaaa0d6887ad51bda.zip | |
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). |