sidekiq-cron 0.6.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c9490a07af91904810a5289c0899691f70bb56b
-  data.tar.gz: 4d79c982c22844a7f7fa887dde61925aaa26e48e
+SHA256:
+  metadata.gz: f484cd18cea7b3b00d83b82c5ae6ca7e2c831b22ed4d00cd77a19cfc9491b49d
+  data.tar.gz: efe62165d5c2b02b4ee2ce7f1ac877cda1bd06d550f4554fbb340b491f8d1319
 SHA512:
-  metadata.gz: c9717f01b61187ffb9cc2024ac3de6a01a1641159ef5f0013f742858a932b01c5a89dcb37abb254484cc1ca9edb6da10cf96fa7d0b2b068199945db18e855c3b
-  data.tar.gz: a06735e8a699441b6b9a0218e99949710b44dc2a1fdf92725fe865594687e428cd7509efd04023a9a09d5f4580466ab117ad6ccc471ab2797fae804fef9a3ea8
+  metadata.gz: a945824e3d39d8f54a33c68eec458f3dee68be2cd43ddf697b7fdd568afff291ff62ee1ec8cf2bbc05e26ddfa6e8230c78a953499b59b6844ca60b37f55ffc99
+  data.tar.gz: 2aa57d5d1e2b4ba98199bf79e13d49b7726478650ef46efa92871e0c13b51608829bc66159d8ed5a2cd58f4b6d5dcb3a6e87329795e604309fc60ba85b583758

data/CHANGELOG.md

@@ -0,0 +1,145 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 1.10.0
+
+- Remove EOL Ruby 2.6 support (https://github.com/sidekiq-cron/sidekiq-cron/pull/399)
+- Add a logo for the project! (https://github.com/sidekiq-cron/sidekiq-cron/pull/402)
+- Added support for ActiveRecord serialize/deserialize using GlobalID (https://github.com/sidekiq-cron/sidekiq-cron/pull/395)
+- Allow for keyword args (`embedded: true`) in Poller (https://github.com/sidekiq-cron/sidekiq-cron/pull/398)
+- Make last_enqueue_time be always an instance of Time (https://github.com/sidekiq-cron/sidekiq-cron/pull/354)
+- Fix argument error problem update from 1.6.0 to newer (https://github.com/sidekiq-cron/sidekiq-cron/pull/392)
+- Clear old jobs while loading the jobs from schedule via the schedule loader (https://github.com/sidekiq-cron/sidekiq-cron/pull/405)
+
+## 1.9.1
+
+- Always enqueue via Active Job interface when defined in cron job config (https://github.com/sidekiq-cron/sidekiq-cron/pull/381)
+- Fix schedule.yml YAML load errors on Ruby 3.1 (https://github.com/sidekiq-cron/sidekiq-cron/pull/386)
+- Require Fugit v1.8 to refactor internals (https://github.com/sidekiq-cron/sidekiq-cron/pull/385)
+
+## 1.9.0
+
+- Sidekiq v7 support (https://github.com/sidekiq-cron/sidekiq-cron/pull/369)
+- Add support for ERB templates in the auto schedule loader (https://github.com/sidekiq-cron/sidekiq-cron/pull/373)
+
+## 1.8.0
+
+- Fix deprecation warnings with redis-rb v4.8.0 (https://github.com/sidekiq-cron/sidekiq-cron/pull/356)
+- Fix poller affecting Sidekiq scheduled set poller (https://github.com/sidekiq-cron/sidekiq-cron/pull/359)
+- Fix default polling interval (https://github.com/sidekiq-cron/sidekiq-cron/pull/362)
+- Add italian locale (https://github.com/sidekiq-cron/sidekiq-cron/pull/367)
+- Allow disabling of cron polling (https://github.com/sidekiq-cron/sidekiq-cron/pull/368)
+
+## 1.7.0
+
+- Enable to use cron notation in natural language (ie `every 30 minutes`) (https://github.com/sidekiq-cron/sidekiq-cron/pull/312)
+- Fix `date_as_argument` feature to add timestamp argument at every cron job execution (https://github.com/sidekiq-cron/sidekiq-cron/pull/329)
+- Introduce `Sidekiq::Options` to centralize reading/writing options from different Sidekiq versions (https://github.com/sidekiq-cron/sidekiq-cron/pull/341)
+- Make auto schedule loading compatible with Array format (https://github.com/sidekiq-cron/sidekiq-cron/pull/345)
+
+## 1.6.0
+
+- Adds support for auto-loading the `config/schedule.yml` file (https://github.com/sidekiq-cron/sidekiq-cron/pull/337)
+- Fix `Sidekiq.options` deprecation warning (https://github.com/sidekiq-cron/sidekiq-cron/pull/338)
+
+## 1.5.1
+
+-  Fixes an issue that prevented the gem to work in previous Sidekiq versions (https://github.com/sidekiq-cron/sidekiq-cron/pull/335)
+
+## 1.5.0
+
+- Integrate Sidekiq v6.5 breaking changes (https://github.com/sidekiq-cron/sidekiq-cron/pull/331)
+- Add portuguese translations (https://github.com/sidekiq-cron/sidekiq-cron/pull/332)
+
+## 1.4.0
+
+- Fix buttons order in job show view (https://github.com/sidekiq-cron/sidekiq-cron/pull/302)
+- Dark Mode support in UI (https://github.com/sidekiq-cron/sidekiq-cron/pull/317/282)
+- Remove invocation of deprecated Redis functionality (https://github.com/sidekiq-cron/sidekiq-cron/pull/318)
+- Internal code cleanup (https://github.com/sidekiq-cron/sidekiq-cron/pull/317)
+- Optimize gem size (https://github.com/sidekiq-cron/sidekiq-cron/pull/322)
+- Fix "Show All" button on cron jobs view with Sidekiq 6.3.0+ (https://github.com/sidekiq-cron/sidekiq-cron/pull/321)
+- Documentation updates
+
+## 1.3.0
+
+- Add confirmation dialog when enquing jobs from UI
+- Start to support Sidekiq `average_scheduled_poll_interval` option (replaced `poll_interval`)
+- Fix deprecation warning for Redis 4.6.x
+- Fix different response from Redis#exists in different Redis versions
+- All PRs:
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/275
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/287
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/309
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/299
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/314
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/288
+
+## 1.2.0
+
+- Updated readme
+- Fix problem with Sidekiq::Launcher and requiring it when not needed
+- Better patching of Sidekiq::Launcher
+- Fixed Dockerfile
+
+## 1.1.0
+
+- Updated readme
+- Fix unit tests - changed argument error when getting invalid cron format
+- When fallbacking old job enqueued time use `Time.parse` without format (so Ruby can decide best method to parse it)
+- Add option `date_as_argument` which will add to your job arguments on last place `Time.now.to_f` when it was eneuqued
+- Add option `description` which will allow you to add notes to your jobs so in web view you can see it
+- Fixed translations
+
+## 1.0.4
+
+- Fix problem with upgrading to 1.0.x - parsing last enqued time didn't count with old time format stored in Redis
+
+## 1.0.0
+
+- Use [fugit](https://github.com/floraison/fugit) instead of [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) - API of cron didn't change (rufus scheduler is using fugit)
+- Better working with Timezones
+- Translations for JA, zh-CN
+- Cron without timezone are considered as UTC, to add Timezone to cron use format `* * * * * Europe/Berlin`
+- Be aware that this release can change when your jobs are enqueued (for me it didn't change but it is in one project, in other it can shift by different timezone setup)
+
+## 0.6.0
+
+- Set poller to check jobs every 30s by default (possible to override by `Sidekiq.options[:poll_interval] = 10`)
+- Add group actions (enqueue, enable, disable, delete) all in web view
+- Fix poller to enqueu all jobs in poll start time
+- Add performance test for enqueue of jobs (10 000 jobs in less than 19s)
+- Fix problem with default queue
+- Remove `redis-namespace` from dependencies
+- Update Ruby versions in Travis
+
+## 0.5.0
+
+- Add Docker support
+- All crons are now evaluated in UTC
+- Fix rufus scheduler & timezones problems
+- Add support for Sidekiq 4.2.1
+- Fix readme
+- Add Russian locale
+- User Rack.env in tests
+- Faster enqueue of jobs
+- Permit to use `ActiveJob::Base.queue_name_delimiter`
+- Fix problem with multiple times enqueue #84
+- Fix problem with enqueue of unknown class
+
+## 0.4.0
+
+- Enable to work with Sidekiq >= 4.0.0
+- Fix readme
+
+## 0.3.1
+
+- Add CSRF tags to forms so it will work with Sidekiq >= 3.4.2
+- Remove Tilt dependency
+
+## 0.3.0
+
+- Suport for Active Job
+- Sidekiq cron web ui needs to be loaded by: require 'sidekiq/cron/web'
+- Add load_from_hash! and load_from_array! which cleanup jobs before adding new ones

data/Gemfile

@@ -1,32 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'sidekiq', '>= 4.2.1'
-gem 'rufus-scheduler', '>= 3.3.0'
+gemspec
 
-group :development do
-  gem 'bundler'
-  gem 'simplecov'
-
-  gem 'redis-namespace', '>= 1.5.2'
-  gem 'shoulda-context'
-
-  gem 'rack'
-  gem 'rack-test'
-
-  gem 'jeweler'
-
-  gem 'minitest'
-  gem 'test-unit'
-  gem 'sdoc' # sdoc -N .
-
-  gem 'slim'
-  gem 'sinatra'
-
-  gem 'mocha'
-  gem 'coveralls'
-
-  gem 'shotgun'
-
-  gem 'guard'
-  gem 'guard-minitest'
-end
+# To test different Sidekiq versions
+gem "sidekiq", ENV.fetch("SIDEKIQ_VERSION", ">= 6")

data/README.md

@@ -1,81 +1,115 @@
-Sidekiq-Cron [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](http://badge.fury.io/rb/sidekiq-cron) [![Build Status](https://travis-ci.org/ondrejbartas/sidekiq-cron.svg?branch=master)](https://travis-ci.org/ondrejbartas/sidekiq-cron) [![Coverage Status](https://coveralls.io/repos/ondrejbartas/sidekiq-cron/badge.svg?branch=master)](https://coveralls.io/r/ondrejbartas/sidekiq-cron?branch=master) [![Dependency Status](https://dependencyci.com/github/ondrejbartas/sidekiq-cron/badge)](https://dependencyci.com/github/ondrejbartas/sidekiq-cron)
-================================================================================================================================================================================================================================================================================================================================================================================================================================================
+![Sidekiq-Cron](logos/cover.png)
 
-[![Join the chat at https://gitter.im/ondrejbartas/sidekiq-cron](https://badges.gitter.im/ondrejbartas/sidekiq-cron.svg)](https://gitter.im/ondrejbartas/sidekiq-cron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](https://badge.fury.io/rb/sidekiq-cron)
+[![Build Status](https://github.com/sidekiq-cron/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/sidekiq-cron/sidekiq-cron/actions)
+[![codecov](https://codecov.io/gh/sidekiq-cron/sidekiq-cron/branch/master/graph/badge.svg?token=VK9IVLIaY8)](https://codecov.io/gh/sidekiq-cron/sidekiq-cron)
 
-[Introduction video about Sidekiq-Cron by Drifting Ruby](https://www.driftingruby.com/episodes/periodic-tasks-with-sidekiq-cron)
+> A scheduling add-on for [Sidekiq](https://sidekiq.org/)
 
-A scheduling add-on for [Sidekiq](http://sidekiq.org).
+🎬 [Introduction video about Sidekiq-Cron by Drifting Ruby](https://www.driftingruby.com/episodes/periodic-tasks-with-sidekiq-cron)
 
-Runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Rufus-Scheduler](https://github.com/jmettraux/rufus-scheduler), more about [cron notation](http://www.nncron.ru/help/EN/working/cron-format.htm).
+Sidekiq-Cron runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Fugit](https://github.com/floraison/fugit)).
 
-Checks for new jobs to schedule every 10 seconds and doesn't schedule the same job multiple times when more than one Sidekiq worker is running.
+Checks for new jobs to schedule every 30 seconds and doesn't schedule the same job multiple times when more than one Sidekiq worker is running.
 
-Scheduling jobs are added only when at least one Sidekiq process is running.
+Scheduling jobs are added only when at least one Sidekiq process is running, but it is safe to use Sidekiq-Cron in environments where multiple Sidekiq processes or nodes are running.
 
-If you want to know how scheduling work, check out [under the hood](#under-the-hood)
+If you want to know how scheduling work, check out [under the hood](#under-the-hood).
 
-Works with ActiveJob (Rails 4.2+)
+Works with ActiveJob (Rails 4.2+).
 
-You don't need Sidekiq PRO, you can use this gem with plain __Sidekiq__.
+You don't need Sidekiq PRO, you can use this gem with plain Sidekiq.
 
-Requirements
------------------
+## Changelog
 
-- Redis 2.8 or greater is required. (Redis 3.0.3 or greater is recommended for large scale use)
-- Sidekiq 5, or 4, or 3 and greater is required (for Sidekiq < 4 use version sidekiq-cron 0.3.1)
+Before upgrading to a new version, please read our [Changelog](CHANGELOG.md).
 
-Change Log
-----------
-before upgrading to new version, please read:
-[Change Log](https://github.com/ondrejbartas/sidekiq-cron/blob/master/Changes.md)
+## Installation
 
-Installation
-------------
+Install the gem:
 
-    $ gem install sidekiq-cron
-
-or add to your `Gemfile`
-
-    gem "sidekiq-cron", "~> 0.4.0"
+```
+$ gem install sidekiq-cron
+```
 
+Or add to your `Gemfile` and run `bundle install`:
 
-Getting Started
------------------
+```ruby
+gem "sidekiq-cron"
+```
 
+**NOTE** If you are not using Rails, you need to add `require 'sidekiq-cron'` somewhere after `require 'sidekiq'`.
 
-If you are not using Rails, you need to add `require 'sidekiq-cron'` somewhere after `require 'sidekiq'`.
+## Getting Started
 
-_Job properties_:
+ ### Job properties
 
 ```ruby
 {
- 'name'  => 'name_of_job', #must be uniq!
- 'cron'  => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, 15:01...etc(HH:MM)
- 'class' => 'MyClass',
- #OPTIONAL
- 'queue' => 'name of queue',
- 'args'  => '[Array or Hash] of arguments which will be passed to perform method',
- 'active_job' => true,  # enqueue job through rails 4.2+ active job interface
- 'queue_name_prefix' => 'prefix', # rails 4.2+ active job queue with prefix
- 'queue_name_delimiter' => '.'  # rails 4.2+ active job queue with custom delimiter
+  # MANDATORY
+  'name' => 'name_of_job', # must be uniq!
+  'cron' => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, ...
+  'class' => 'MyClass',
+  # OPTIONAL
+  'queue' => 'name of queue',
+  'args' => '[Array or Hash] of arguments which will be passed to perform method',
+  'date_as_argument' => true, # add the time of execution as last argument of the perform method
+  'active_job' => true,  # enqueue job through Rails 4.2+ Active Job interface
+  'queue_name_prefix' => 'prefix', # Rails 4.2+ Active Job queue with prefix
+  'queue_name_delimiter' => '.', # Rails 4.2+ Active Job queue with custom delimiter
+  'description' => 'A sentence describing what work this job performs'
+  'status' => 'disabled' # default: enabled
 }
 ```
 
-### Time, cron and sidekiq-cron
+### Time, cron and Sidekiq-Cron
+
+For testing your cron notation you can use [crontab.guru](https://crontab.guru).
+
+Sidekiq-Cron uses [Fugit](https://github.com/floraison/fugit) to parse the cronline. So please, check Fugit documentation for further information about allowed formats.
+
+If using Rails, this is evaluated against the timezone configured in Rails, otherwise the default is UTC.
 
-sidekiq-cron uses [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) to parse the cronline.
-By default, the timezone this is evaluated against UTC.
 If you want to have your jobs enqueued based on a different time zone you can specify a timezone in the cronline,
 like this `'0 22 * * 1-5 America/Chicago'`.
-See [rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler#a-note-about-timezones) for more information.
+
+#### Natural-language formats
+
+Since sidekiq-cron `v1.7.0`, you can use the natural-language formats supported by Fugit, such as:
+
+```rb
+"every day at five" # => '0 5 * * *'
+"every 3 hours"     # => '0 */3 * * *'
+```
+
+See [the relevant part of Fugit documentation](https://github.com/floraison/fugit#fugitnat) for details.
+
+#### Second-precision (sub-minute) cronlines
+
+In addition to the standard 5-parameter cronline format, sidekiq-cron supports scheduling jobs with second-precision using a modified 6-parameter cronline format:
+
+`Seconds Minutes Hours Days Months DayOfWeek`
+
+For example: `"*/30 * * * * *"` would schedule a job to run every 30 seconds.
+
+Note that if you plan to schedule jobs with second precision you may need to override the default schedule poll interval so it is lower than the interval of your jobs:
+
+```ruby
+Sidekiq::Options[:cron_poll_interval] = 10
+```
+
+The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
 
 ### What objects/classes can be scheduled
+
 #### Sidekiq Worker
+
 In this example, we are using `HardWorker` which looks like:
+
 ```ruby
 class HardWorker
   include Sidekiq::Worker
+
   def perform(*args)
     # do something
   end
@@ -83,7 +117,9 @@ end
 ```
 
 #### Active Job Worker
-You can schedule: `ExampleJob` which looks like:
+
+You can schedule `ExampleJob` which looks like:
+
 ```ruby
 class ExampleJob < ActiveJob::Base
   queue_as :default
@@ -94,17 +130,21 @@ class ExampleJob < ActiveJob::Base
 end
 ```
 
-#### Adding Cron job:
-```ruby
+For Active jobs you can use `symbolize_args: true` in `Sidekiq::Cron::Job.create` or in Hash configuration,
+which will ensure that arguments you are passing to it will be symbolized when passed back to `perform` method in worker.
 
+#### Adding Cron job
+
+```ruby
 class HardWorker
   include Sidekiq::Worker
+
   def perform(name, count)
     # do something
   end
 end
 
-Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker') # execute at every 5 minutes, ex: 12:05, 12:10, 12:15...etc
+Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker') # execute at every 5 minutes
 # => true
 ```
 
@@ -119,16 +159,35 @@ else
   puts job.errors
 end
 
-#or simple
-
+# or simple
 unless job.save
-  puts job.errors #will return array of errors
+  puts job.errors # will return array of errors
+end
+```
+
+Use ActiveRecord models as arguments
+
+```rb
+class Person < ApplicationRecord
+end
+
+class HardWorker < ActiveJob::Base
+  queue_as :default
+
+  def perform(person)
+    puts "person: #{person}"
+  end
 end
+
+
+person = Person.create(id: 1)
+Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker', args: person)
+# => true
 ```
 
 Load more jobs from hash:
-```ruby
 
+```ruby
 hash = {
   'name_of_job' => {
     'class' => 'MyClass',
@@ -145,6 +204,7 @@ Sidekiq::Cron::Job.load_from_hash hash
 ```
 
 Load more jobs from array:
+
 ```ruby
 array = [
   {
@@ -163,17 +223,17 @@ array = [
 Sidekiq::Cron::Job.load_from_array array
 ```
 
-Bang-suffixed methods will remove jobs that are not present in the given hash/array,
-update jobs that have the same names, and create new ones when the names are previously unknown.
+Bang-suffixed methods will remove jobs that are not present in the given hash/array, update jobs that have the same names, and create new ones when the names are previously unknown.
 
 ```ruby
-Sidekiq::Cron::Job#load_from_hash! hash
-Sidekiq::Cron::Job#load_from_array! array
+Sidekiq::Cron::Job.load_from_hash! hash
+Sidekiq::Cron::Job.load_from_array! array
 ```
 
-or from YML (same notation as Resque-scheduler)
+Or from YAML (same notation as Resque-scheduler):
+
 ```yaml
-#config/schedule.yml
+# config/schedule.yml
 
 my_first_job:
   cron: "*/5 * * * *"
@@ -188,65 +248,80 @@ second_job:
     hard: "stuff"
 ```
 
+There are multiple ways to load the jobs from a YAML file
+
+1. The gem will automatically load the jobs mentioned in `config/schedule.yml` file (it supports ERB)
+2. When you want to load jobs from a different filename, mention the filename in sidekiq configuration, i.e. `cron_schedule_file: "config/users_schedule.yml"`
+3. Load the file manually as follows:
+
 ```ruby
-#initializers/sidekiq.rb
-schedule_file = "config/schedule.yml"
+# config/initializers/sidekiq.rb
 
-if File.exists?(schedule_file) && Sidekiq.server?
-  Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
+Sidekiq.configure_server do |config|
+  config.on(:startup) do
+    schedule_file = "config/users_schedule.yml"
+
+    if File.exist?(schedule_file)
+      Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
+    end
+  end
 end
 ```
 
-or you can use for loading jobs from yml file [sidekiq-cron-tasks](https://github.com/coverhound/sidekiq-cron-tasks) which will add rake task `bundle exec rake sidekiq_cron:load` to your rails application.
+### Finding jobs
 
-#### Finding jobs
 ```ruby
-#return array of all jobs
+# return array of all jobs
 Sidekiq::Cron::Job.all
 
-#return one job by its unique name - case sensitive
+# return one job by its unique name - case sensitive
 Sidekiq::Cron::Job.find "Job Name"
 
-#return one job by its unique name - you can use hash with 'name' key
+# return one job by its unique name - you can use hash with 'name' key
 Sidekiq::Cron::Job.find name: "Job Name"
 
-#if job can't be found nil is returned
+# if job can't be found nil is returned
 ```
 
-#### Destroy jobs:
+### Destroy jobs
+
 ```ruby
-#destroys all jobs
+# destroy all jobs
 Sidekiq::Cron::Job.destroy_all!
 
-#destroy job by its name
+# destroy job by its name
 Sidekiq::Cron::Job.destroy "Job Name"
 
-#destroy found job
+# destroy found job
 Sidekiq::Cron::Job.find('Job name').destroy
 ```
 
-#### Work with job:
+### Work with job
+
 ```ruby
 job = Sidekiq::Cron::Job.find('Job name')
 
-#disable cron scheduling
+# disable cron scheduling
 job.disable!
 
-#enable cron scheduling
+# enable cron scheduling
 job.enable!
 
-#get status of job:
+# get status of job:
 job.status
 # => enabled/disabled
 
-#enqueue job right now!
+# enqueue job right now!
 job.enque!
 ```
 
-How to start scheduling?
+### How to start scheduling?
+
 Just start Sidekiq workers by running:
 
-    sidekiq
+```
+$ bundle exec sidekiq
+```
 
 ### Web UI for Cron Jobs
 
@@ -254,66 +329,45 @@ If you are using Sidekiq's web UI and you would like to add cron jobs too to thi
 add `require 'sidekiq/cron/web'` after `require 'sidekiq/web'`.
 
 With this, you will get:
-![Web UI](https://github.com/ondrejbartas/sidekiq-cron/raw/master/examples/web-cron-ui.png)
 
-### Forking Processes
-
-If you're using a forking web server like Unicorn you may run into an issue where the Redis connection is used
-before the process forks, causing the following exception
-
-    Redis::InheritedError: Tried to use a connection from a child process without reconnecting. You need to reconnect to Redis after forking.
-
-to occcur. To avoid this, wrap your job creation in the call to `Sidekiq.configure_server`:
-
-```ruby
-Sidekiq.configure_server do |config|
-  schedule_file = "config/schedule.yml"
-
-  if File.exists?(schedule_file)
-    Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
-  end
-end
-```
-
-Note that this API is only available in Sidekiq 3.x.x.
+![Web UI](docs/images/web-cron-ui.jpeg)
 
 ## Under the hood
 
 When you start the Sidekiq process, it starts one thread with `Sidekiq::Poller` instance, which perform the adding of scheduled jobs to queues, retries etc.
 
-Sidekiq-Cron adds itself into this start procedure and starts another thread with `Sidekiq::Cron::Poller` which checks all enabled Sidekiq cron jobs every 10 seconds, if they should be added to queue (their cronline matches time of check).
+Sidekiq-Cron adds itself into this start procedure and starts another thread with `Sidekiq::Cron::Poller` which checks all enabled Sidekiq cron jobs every 30 seconds, if they should be added to queue (their cronline matches time of check).
 
 Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can change it by setting:
+
+```ruby
+Sidekiq::Options[:cron_poll_interval] = 10
 ```
-Sidekiq.options[:poll_interval] = 10
-```
 
-## Thanks to
-* [@7korobi](https://github.com/7korobi)
-* [@antulik](https://github.com/antulik)
-* [@felixbuenemann](https://github.com/felixbuenemann)
-* [@gstark](https://github.com/gstark)
-* [@RajRoR](https://github.com/RajRoR)
-* [@romeuhcf](https://github.com/romeuhcf)
-* [@siruguri](https://github.com/siruguri)
-* [@Soliah](https://github.com/Soliah)
-* [@stephankaag](https://github.com/stephankaag)
-* [@sue445](https://github.com/sue445)
-* [@sylg](https://github.com/sylg)
-* [@tmeinlschmidt](https://github.com/tmeinlschmidt)
-* [@zerobearing2](https://github.com/zerobearing2)
+Sidekiq-Cron is safe to use with multiple Sidekiq processes or nodes. It uses a Redis sorted set to determine that only the first process who asks can enqueue scheduled jobs into the queue.
+
+When running with many Sidekiq processes, the polling can add significant load to Redis. You can disable polling on some processes by setting `Sidekiq::Options[:cron_poll_interval] = 0` on these processes.
 
+## Contributing
 
-## Contributing to sidekiq-cron
+**Thanks to all [contributors](https://github.com/sidekiq-cron/sidekiq-cron/graphs/contributors), you’re awesome and this wouldn’t be possible without you!**
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* Open a pull request!
+
+### Testing
+
+You can execute the test suite by running:
+
+```
+$ bundle exec rake test
+```
 
-## Copyright
+## License
 
-Copyright (c) 2013 Ondrej Bartas. See LICENSE.txt for further details.
+Copyright (c) 2013 Ondrej Bartas. See [LICENSE](LICENSE.txt) for further details.