# <%= class_name %>

Introduction goes here.

## Installation

Add to your application's Gemfile

```
gem "<%= extension_name %>", github: "USERNAME/<%= extension_name %>"
```

Run the bundle command

```
$ bundle install
```

Run the install generator

```
$ bundle exec rails g <%= extension_name %>:install
```

If your server was running, restart it to find the assets properly.

## Updating

Subsequent updates can be done by bumping the version in your Gemfile then adding the new migrations

```
$ bundle exec rails <%= extension_name %>:install:migrations
```

Run migrations

```
$ bundle exec rails db:migrate
```

## Testing

First, generate a dummy application. You will be required to generate a dummy application before running tests.

```
$ bundle exec rake dummy_app
```

Run tests with any of the following

```
$ bundle exec rake
$ bundle exec rake spec
$ bundle exec rake test
$ bundle exec rspec spec
```

When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:

```
require "<%= extension_name %>/factories"
```

## Contributing

1. Fork it ( https://github.com/USERNAME/<%= extension_name %>/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request