Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bensheldon authored Mar 4, 2020
1 parent 70a2f00 commit a965bd4
Showing 1 changed file with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,27 @@

GoodJob is a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'good_job', github: 'bensheldon/good_job'
```

And then execute:
```bash
$ bundle
```

## Usage

1. Create a database migration:
```bash
bin/rails g migration CreateGoodJobs
$ bin/rails g migration CreateGoodJobs
```

And then add to the newly created file:
Add to the newly created migration file:

```ruby
class CreateGoodJobs < ActiveRecord::Migration[6.0]
Expand All @@ -27,6 +40,13 @@ GoodJob is a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails.
end
end
```

Run the migration:

```bash
$ bin/rails db:migrate
```

1. Configure the ActiveJob adapter:
```ruby
# config/environments/production.rb
Expand All @@ -41,18 +61,6 @@ GoodJob is a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails.
$ bundle exec good_job
```

## Installation
Add this line to your application's Gemfile:
```ruby
gem 'good_job', github: 'bensheldon/good_job'
```
And then execute:
```bash
$ bundle
```
## Development

To run tests:
Expand Down Expand Up @@ -96,7 +104,9 @@ $ gem release
```

## 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).

0 comments on commit a965bd4

Please sign in to comment.