README.md in mini_scheduler-0.15.0 vs README.md in mini_scheduler-0.16.0
- old
+ new
@@ -1,19 +1,17 @@
[](https://github.com/discourse/mini_scheduler/actions)
[](https://rubygems.org/gems/mini_scheduler)
-# mini_scheduler
+# MiniScheduler
MiniScheduler adds recurring jobs to [Sidekiq](https://sidekiq.org/).
-
-
## Installation
Add this line to your application's Gemfile:
-```ruby
+```rb
gem 'mini_scheduler'
```
And then execute:
@@ -23,20 +21,20 @@
$ gem install mini_scheduler
In a Rails application, create files needed in your application to configure mini_scheduler:
- bin/rails g mini_scheduler:install
- rake db:migrate
+ $ bin/rails g mini_scheduler:install
+ $ bin/rails db:migrate
An initializer is created named `config/initializers/mini_scheduler.rb` which lists all the configuration options.
## Configuring MiniScheduler
By default each instance of MiniScheduler will run with a single worker. To amend this behavior:
-```
+```rb
if Sidekiq.server? && defined?(Rails)
Rails.application.config.after_initialize do
MiniScheduler.start(workers: 5)
end
end
@@ -46,11 +44,11 @@
## Usage
Create jobs with a recurring schedule like this:
-```ruby
+```rb
class MyHourlyJob
include Sidekiq::Worker
extend MiniScheduler::Schedule
every 1.hour
@@ -61,23 +59,25 @@
end
```
Options for schedules:
-* **queue** followed by a queue name, like "queue :email", default queue is "default"
-* **every** followed by a duration in seconds, like "every 1.hour".
-* **daily at:** followed by a duration since midnight, like "daily at: 12.hours", to run only once per day at a specific time.
+- **queue** followed by a queue name, like "queue :email", default queue is "default"
+- **every** followed by a duration in seconds, like "every 1.hour".
+- **daily at:** followed by a duration since midnight, like "daily at: 12.hours", to run only once per day at a specific time.
To view the scheduled jobs, their history, and the schedule, go to sidekiq's web UI and look for the "Scheduler" tab at the top.
To enable this view in Sidekiq, add `require "mini_scheduler/web"` to `routes.rb`:
-
- ```ruby
+
+```rb
require "sidekiq/web"
require "mini_scheduler/web"
+
Rails.application.routes.draw do
- ...
-
+ ...
+end
```
+
## How to reach us
If you have questions about using mini_scheduler or found a problem, you can find us at https://meta.discourse.org.