kotovalexarian-likes-github/endofunky--sidetiq
1
0
Fork 0
mirror of https://github.com/endofunky/sidetiq.git synced 2022-11-09 13:53:30 -05:00
Code Releases Activity

Add table of contents to readme.

Browse source
This commit is contained in:
Tobias Svensson 2013-03-11 13:37:14 +00:00
parent bf940ccffc
commit ba99388c7e
1 changed files with 29 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -6,7 +6,22 @@ Sidetiq
Recurring jobs for [Sidekiq](http://mperham.github.com/sidekiq/). Recurring jobs for [Sidekiq](http://mperham.github.com/sidekiq/).
## DESCRIPTION ## TABLE OF CONTENTS
* [Overview](#section_Overview)
* [Dependencies](#section_Dependencies)
* [Installation](#section_Installation)
* [Introduction](#section_Introduction)
* [Configuration](#section_Configuration)
* [API](#section_API)
* [Polling](#section_Polling)
* [Web Extension](#section_WebExtension)
* [Contribute](#section_Contribute)
* [License](#section_License)
* [Author](#section_Author)
<a name='section_Overview></a>
## OVERVIEW
Sidetiq provides a simple API for defining recurring workers for Sidekiq. Sidetiq provides a simple API for defining recurring workers for Sidekiq.
@ -20,11 +35,13 @@ Sidetiq provides a simple API for defining recurring workers for Sidekiq.
each other (tested with sub-second polling of scheduled jobs by Sidekiq and each other (tested with sub-second polling of scheduled jobs by Sidekiq and
Sidetiq clock rates above 100hz). Sidetiq clock rates above 100hz).
<a name='section_Dependencies></a>
## DEPENDENCIES ## DEPENDENCIES
- [Sidekiq](http://mperham.github.com/sidekiq/) - [Sidekiq](http://mperham.github.com/sidekiq/)
- [ice_cube](http://seejohnrun.github.com/ice_cube/) - [ice_cube](http://seejohnrun.github.com/ice_cube/)
<a name='section_Installation></a>
## INSTALLATION ## INSTALLATION
The best way to install Sidetiq is with RubyGems: The best way to install Sidetiq is with RubyGems:
@ -36,7 +53,8 @@ to pick up all the gems ([more info](http://gembundler.com/bundle_install.html))
$ bundle install $ bundle install
## GETTING STARTED <a name='section_Introduction></a>
## INTRODUCTION
Defining recurring jobs is simple: Defining recurring jobs is simple:
@ -91,6 +109,7 @@ end
Additionally, Sidetiq includes a middleware that will check if the clock Additionally, Sidetiq includes a middleware that will check if the clock
thread is still alive and restart it if necessary. thread is still alive and restart it if necessary.
<a name='section_Configuration></a>
## CONFIGURATION ## CONFIGURATION
```ruby ```ruby
@ -110,6 +129,7 @@ Sidetiq.configure do |config|
end end
``` ```
<a name='section_API></a>
## API ## API
Sidetiq implements a simple API to support reflection of recurring jobs at Sidetiq implements a simple API to support reflection of recurring jobs at
@ -159,7 +179,8 @@ Sidetiq.retries(MyWorker) do |job|
end end
``` ```
## JOB POLLING <a name='section_Polling></a>
## POLLING
By default Sidekiq uses a 15 second polling interval to check if scheduled By default Sidekiq uses a 15 second polling interval to check if scheduled
jobs are due. If a recurring job has to run more often than that you should jobs are due. If a recurring job has to run more often than that you should
@ -169,6 +190,7 @@ lower this value.
Sidekiq.options[:poll_interval] = 1 Sidekiq.options[:poll_interval] = 1
``` ```
<a name='section_WebExtension></a>
## WEB EXTENSION ## WEB EXTENSION
Sidetiq includes an extension for Sidekiq's web interface. It will not be Sidetiq includes an extension for Sidekiq's web interface. It will not be
@ -182,6 +204,7 @@ require 'sidetiq/web'
![Screenshot](http://f.cl.ly/items/1P2u1v091F3V1n381g2I/Screen%20Shot%202013-02-01%20at%2012.16.17.png) ![Screenshot](http://f.cl.ly/items/1P2u1v091F3V1n381g2I/Screen%20Shot%202013-02-01%20at%2012.16.17.png)
<a name='section_Contribute></a>
## CONTRIBUTE ## CONTRIBUTE
If you'd like to contribute to Sidetiq, start by forking my repo on GitHub: If you'd like to contribute to Sidetiq, start by forking my repo on GitHub:
@ -201,10 +224,13 @@ your changes merged back into core is as follows:
1. Push the branch up to GitHub 1. Push the branch up to GitHub
1. Send a pull request to the tobiassvn/sidetiq project. 1. Send a pull request to the tobiassvn/sidetiq project.
<a name='section_License></a>
## LICENSE ## LICENSE
Sidetiq is released under the MIT License. See LICENSE for further details. Sidetiq is released under the MIT License. See LICENSE for further details.
<a name='section_Author></a>
## AUTHOR ## AUTHOR
Tobias Svensson, [@tobiassvn](https://twitter.com/tobiassvn), [http://github.com/tobiassvn](http://github.com/tobiassvn) Tobias Svensson, [@tobiassvn](https://twitter.com/tobiassvn), [http://github.com/tobiassvn](http://github.com/tobiassvn)