From c79ae86a56114c5492cb9a4022c168d334d045b7 Mon Sep 17 00:00:00 2001 From: maetl Date: Wed, 2 May 2012 19:36:02 +1000 Subject: [PATCH 1/2] use short filenames for markdown docs --- CHANGELOG.markdown => CHANGELOG.md | 0 README.markdown => README.md | 0 TODO.markdown => TODO.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename CHANGELOG.markdown => CHANGELOG.md (100%) rename README.markdown => README.md (100%) rename TODO.markdown => TODO.md (100%) diff --git a/CHANGELOG.markdown b/CHANGELOG.md similarity index 100% rename from CHANGELOG.markdown rename to CHANGELOG.md diff --git a/README.markdown b/README.md similarity index 100% rename from README.markdown rename to README.md diff --git a/TODO.markdown b/TODO.md similarity index 100% rename from TODO.markdown rename to TODO.md From df8853ee4fd07f797b0ba6fed47a5e2f0efe6685 Mon Sep 17 00:00:00 2001 From: maetl Date: Wed, 2 May 2012 19:37:36 +1000 Subject: [PATCH 2/2] removing a lie; adding some structure --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fe88316..552b8a7 100644 --- a/README.md +++ b/README.md @@ -4,31 +4,30 @@ php-resque: PHP Resque Worker (and Enqueue) [![Build Status](https://secure.trav Resque is a Redis-backed library for creating background jobs, placing those jobs on multiple queues, and processing them later. -Resque was pioneered and is developed by the fine folks at GitHub (yes, -I am a kiss-ass), and written in Ruby. +## Background ## -What you're seeing here is an almost direct port of the Resque worker -and enqueue system to PHP, which I've thrown together because I'm sure -my PHP developers would have a fit if they had to write a line of Ruby. +Resque was pioneered and is developed by the fine folks at GitHub (yes, +I am a kiss-ass), and written in Ruby. What you're seeing here is an +almost direct port of the Resque worker and enqueue system to PHP. For more information on Resque, visit the official GitHub project: -And for background information, the launch post on the GitHub blog: +For further information, see the launch post on the GitHub blog: The PHP port does NOT include its own web interface for viewing queue stats, as the data is stored in the exact same expected format as the Ruby version of Resque. -The PHP port allows for much the same as the Ruby version of Rescue: +The PHP port provides much the same features as the Ruby version: * Workers can be distributed between multiple machines * Includes support for priorities (queues) * Resilient to memory leaks (fork) * Expects failure -In addition, it also: +It also supports the following additional features: * Has the ability to track the status of jobs * Will mark a job as failed, if a forked child running a job does @@ -36,7 +35,10 @@ not exit with a status code as 0 * Has built in support for `setUp` and `tearDown` methods, called pre and post jobs -Note: php-resque requires at least Redis 2.2. +## Requirements ## + +* PHP 5.2+ +* Redis 2.2+ ## Jobs ##