<%= class_name %>¶ ↑
Introduction goes here.
Installation¶ ↑
-
Add this extension to your Gemfile with this line:
gem '<%= file_name %>'
-
Install the gem using Bundler
bundle install
-
Copy & run migrations
bundle exec rails g <%= file_name %>:install
-
Restart your server
If your server was running, restart it so that it can find the assets properly.
Testing¶ ↑
First bundle your dependencies, then run rake
. rake
will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using rake test_app
.
bundle update bundle exec rake
When testing your applications integration with this extension you may use it’s factories. Simply add this require statement to your spec_helper:
require '<%= file_name %>/factories'
Releasing¶ ↑
bundle exec gem bump -p -t bundle exec gem release
For more options please see gem-release README
Contributing¶ ↑
If you’d like to contribute, please take a look at the instructions for installing dependencies and crafting a good pull request.
Copyright © <%= Time.now.year %> [name of extension creator], released under the New BSD License