diff --git a/README.md b/README.md index a0269f6..c3d4e12 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,22 @@ Sidetiq 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) + + ## DEPENDENCIES - [Sidekiq](http://mperham.github.com/sidekiq/) - [ice_cube](http://seejohnrun.github.com/ice_cube/) + +## INTRODUCTION Defining recurring jobs is simple: @@ -91,6 +109,7 @@ end Additionally, Sidetiq includes a middleware that will check if the clock thread is still alive and restart it if necessary. + ## API Sidetiq implements a simple API to support reflection of recurring jobs at @@ -159,7 +179,8 @@ Sidetiq.retries(MyWorker) do |job| end ``` -## JOB POLLING + ## WEB EXTENSION 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) + ## AUTHOR Tobias Svensson, [@tobiassvn](https://twitter.com/tobiassvn), [http://github.com/tobiassvn](http://github.com/tobiassvn) +