aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/generators/rails/plugin/templates/README.md.tt
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails/generators/rails/plugin/templates/README.md.tt')
-rw-r--r--railties/lib/rails/generators/rails/plugin/templates/README.md.tt28
1 files changed, 28 insertions, 0 deletions
diff --git a/railties/lib/rails/generators/rails/plugin/templates/README.md.tt b/railties/lib/rails/generators/rails/plugin/templates/README.md.tt
new file mode 100644
index 0000000000..1632409bea
--- /dev/null
+++ b/railties/lib/rails/generators/rails/plugin/templates/README.md.tt
@@ -0,0 +1,28 @@
+# <%= camelized_modules %>
+Short description and motivation.
+
+## 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](https://opensource.org/licenses/MIT).