README.md in rekiq-0.5.0 vs README.md in rekiq-0.6.0
- old
+ new
@@ -1,30 +1,32 @@
# Rekiq
+[](http://badge.fury.io/rb/rekiq)
[](https://travis-ci.org/junhanamaki/rekiq)
[](https://codeclimate.com/github/junhanamaki/rekiq)
[](https://codeclimate.com/github/junhanamaki/rekiq)
[](https://gemnasium.com/junhanamaki/rekiq)
**Rekiq is a recurring worker extension for
[Sidekiq](https://github.com/mperham/sidekiq).**
Rekiq extends Sidekiq and adds functionality to schedule recurring workers.
-Sidekiq is an amazing gem that allows us delegate time consuming work to a
-worker, or even to schedule a time for the worker to start. Now wouldn't it be
-nice if it also allowed us to schedule a worker to do work recurringly? That's
+Sidekiq is an amazing gem that allows us to execute work asynchronous, or
+even schedule that work to be run at a given time. Now, wouldn't it be
+nice if it also allowed us to schedule a worker to do recurring work? That's
what rekiq purposes to do.
For example, rekiq allows you to schedule a worker to repeat the same
work every friday at 23:00.
## Dependencies
Tested with:
* ruby 2.1.1, 2.0.0 and 1.9.3
+
* sidekiq 3.2.1
## Installation
Add this line to your application's Gemfile:
@@ -67,11 +69,13 @@
end
# now just start your worker
ExampleWorker.perform_recurringly(schedule, 'argument_1', 'argument_2')
- You can use your own schedule object, configure worker to reschedule before or
-after work is done, set margin, and much more! So please check
+ And that's it! Now the worker will run every friday as 2am.
+
+You can use your own schedule object, configure worker to schedule before or
+after work is done, set a margin, and much more! So please feel free to check
[wiki](https://github.com/junhanamaki/rekiq/wiki) for more details.
## Contributing
1. Fork it ( https://github.com/[my-github-username]/rekiq/fork )