<commit_before>Sidetiq
=======

[![Build Status](https://travis-ci.org/tobiassvn/sidetiq.png)](https://travis-ci.org/tobiassvn/sidetiq)
[![Dependency Status](https://gemnasium.com/tobiassvn/sidetiq.png)](https://gemnasium.com/tobiassvn/sidetiq)

Recurring jobs for [Sidekiq](http://mperham.github.com/sidekiq/).

Table Of Contents
-----------------

   * [Overview](#section_Overview)
   * [Dependencies](#section_Dependencies)
   * [Installation](#section_Installation)
   * [Introduction](#section_Introduction)
   * [Configuration](#section_Configuration)
   * [API](#section_API)
   * [Polling](#section_Polling)
   * [Known Issues](#section_Known_Issues)
   * [Web Extension](#section_Web_Extension)
   * [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.

- Flexible DSL based on [ice_cube](http://seejohnrun.github.com/ice_cube/)

- High-resolution timer using `clock_gettime(3)` (or `mach_absolute_time()` on
  Apple Mac OS X), allowing for accurate sub-second clock ticks.

- Sidetiq uses a locking mechanism (based on `setnx` and `pexpire`) internally
  so Sidetiq clocks can run in each Sidekiq process without interfering with
  each other (tested with sub-second polling of scheduled jobs by Sidekiq and
  Sidetiq clock rates above 100hz).

<a name='section_Dependencies'></a>
Dependencies
------------

- [Sidekiq](http://mperham.github.com/sidekiq/)
- [ice_cube](http://seejohnrun.github.com/ice_cube/)

<a name='section_Installation'></a>
Installation
------------

The best way to install Sidetiq is with RubyGems:

    $ [sudo] gem install sidetiq
<commit_msg>Add rubydoc.info link to README.<commit_after>Sidetiq
=======

[![Build Status](https://travis-ci.org/tobiassvn/sidetiq.png)](https://travis-ci.org/tobiassvn/sidetiq)
[![Dependency Status](https://gemnasium.com/tobiassvn/sidetiq.png)](https://gemnasium.com/tobiassvn/sidetiq)

Recurring jobs for [Sidekiq](http://mperham.github.com/sidekiq/).

Table Of Contents
-----------------

   * [Overview](#section_Overview)
   * [Dependencies](#section_Dependencies)
   * [Installation](#section_Installation)
   * [Introduction](#section_Introduction)
   * [Configuration](#section_Configuration)
   * [API](#section_API)
   * [Polling](#section_Polling)
   * [Known Issues](#section_Known_Issues)
   * [Web Extension](#section_Web_Extension)
   * [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.

- Flexible DSL based on [ice_cube](http://seejohnrun.github.com/ice_cube/)

- High-resolution timer using `clock_gettime(3)` (or `mach_absolute_time()` on
  Apple Mac OS X), allowing for accurate sub-second clock ticks.

- Sidetiq uses a locking mechanism (based on `setnx` and `pexpire`) internally
  so Sidetiq clocks can run in each Sidekiq process without interfering with
  each other (tested with sub-second polling of scheduled jobs by Sidekiq and
  Sidetiq clock rates above 100hz).

Detailed API documentation is available on [rubydoc.info](http://rdoc.info/github/tobiassvn/sidetiq/).

<a name='section_Dependencies'></a>
Dependencies
------------

- [Sidekiq](http://mperham.github.com/sidekiq/)
- [ice_cube](http://seejohnrun.github.com/ice_cube/)

<a name='section_Installation'></a>
Installation
------------

The best way to install Sidetiq is with RubyGems:

    $ [sudo] gem install sidetiq

{'fraction_non_alphanumeric': 0.15889655172413794, 'fraction_numerical': 0.002206896551724138, 'mean_word_length': 4.460843373493976, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7670915', 'n_tokens_mistral': 1272, 'n_tokens_neox': 1168, 'n_words': 257}