Sha256: 2ac05b56923f0846feefcdd60cda0b50a645522dfae99f85b1611f0e4c8a77a1
Contents?: true
Size: 1.3 KB
Versions: 10
Compression:
Stored size: 1.3 KB
Contents
# <%= class_name %>
Introduction goes here.
## Installation
1. Add this extension to your Gemfile with this line:
```ruby
gem '<%= file_name %>'
```
2. Install the gem using Bundler
```ruby
bundle install
```
3. Copy & run migrations
```ruby
bundle exec rails g <%= file_name %>:install
```
4. 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`.
```shell
bundle
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:
```ruby
require '<%= file_name %>/factories'
```
## Releasing
```shell
bundle exec gem bump -p -t
bundle exec gem release
```
For more options please see [gem-release REAMDE](https://github.com/svenfuchs/gem-release)
## Contributing
If you'd like to contribute, please take a look at the
[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
pull request.
Copyright (c) <%= Time.now.year %> [name of extension creator], released under the New BSD License
Version data entries
10 entries across 10 versions & 1 rubygems