From f9b328b6d037fd8e0221d0070dd89c94b8d6ad44 Mon Sep 17 00:00:00 2001 From: lostboy Date: Sat, 18 Feb 2012 21:25:42 +0700 Subject: [PATCH 1/4] Update README to explain install for rails versions --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86dd598..1fd468c 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,39 @@ This is an addon for delayed_job (> 2.0.0) http://github.com/collectiveidea/delayed_job It is designed to be used when you're using Heroku as a host and have the need to do background work with delayed job but you don't want to leave the workers running all the time as it costs money. -You basically add the gem to your project and the rest is taken care of for you given a few CONFIG vars set on Heroku. +By adding the gem to your project and configuring our Heroku app with some config variables workless should do the rest. -There are already a few of these out there, notably @mtravers' cheepnis http://github.com/mtravers/cheepnis and the autoscale branch of delayed_job by @pedro http://github.com/pedro/delayed_job/tree/autoscaling +## Update -Workless takes ideas from both and is helping me understand gem and plugin development. Prior to version 1.0.0 it was originally built for rails 3 on the delayed_job 2.1.0.pre2 but since 1.0.0 is compatible with rails 2.3.x, 3.0.x, 3.1.x and 3.2.x +Version 1.0.0 has been released, this brings compatibility with delayed_job 3 and compatibility with Rails 2.3.x and up. ## Installation Add the workless gem and the delayed_job gem to your project Gemfile and update your bundle. Its is recommended to specify the gem version for delayed_job especially if you are using rails 2.3.x which doesn't work with the latest delayed_job +### For rails 2.3.x the latest compatible delayed_job is 2.0.7 + +
+gem "delayed_job", "2.0.7"
+gem "workless", "~> 1.0.1"
+
+ +### For rails 3.x with delayed_job 2.1.x + 
-gem "workless"
+gem "delayed_job", "~> 2.1.4"
+gem "workless", "~> 1.0.1"
+### For rails 3.x with latest delayed_job 3.x + +
+gem "delayed_job", "~> 3.0.1"
+gem "workless", "~> 1.0.1"
+
+ +If you don't specify delayed_job in your Gemfile workless will bring it in, most likly the latest version (3.0.1) + Add your Heroku username / password as config vars to your Heroku instance, the same one you log in to Heroku with 

From 0267678df8ca95ba59701522fe8682f7eb070cd7 Mon Sep 17 00:00:00 2001
From: lostboy 
Date: Mon, 20 Feb 2012 17:26:10 +0700
Subject: [PATCH 2/4] updated README to show tested compatibility

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 1fd468c..7851df5 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,16 @@ By adding the gem to your project and configuring our Heroku app with some confi
 
 Version 1.0.0 has been released, this brings compatibility with delayed_job 3 and compatibility with Rails 2.3.x and up.
 
+## Compatibility
+
+Workless should work correctly with Rubies 1.8.7, ree, 1.9.2 and 1.9.3. It is compatible with Delayed Job since version 2.0.7 up to the latest version 3.0.1, the table below shows tested compatibility with ruby, rails and delayed_job
+
+Ruby | Rails  | Delayed Job
+---------- | ------ | -----
+1.8.7-ree  | 2.1.14 | 2.0.7
+1.9.2      | 3.2    | 2.1.4
+1.9.2      | 3.2    | 3.0.1
+
 ## Installation
 
 Add the workless gem and the delayed_job gem to your project Gemfile and update your bundle. Its is recommended to specify the gem version for delayed_job especially if you are using rails 2.3.x which doesn't work with the latest delayed_job

From 9638c6386df20e3cf7466bba58f933aa7995867e Mon Sep 17 00:00:00 2001
From: lostboy 
Date: Wed, 22 Feb 2012 19:29:44 +0700
Subject: [PATCH 3/4] updated README to show dj 3 with activerecord

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7851df5..b41064d 100644
--- a/README.md
+++ b/README.md
@@ -39,10 +39,10 @@ gem "delayed_job", "~> 2.1.4"
 gem "workless", "~> 1.0.1"
-### For rails 3.x with latest delayed_job 3.x +### For rails 3.x with latest delayed_job 3.x using active record 
-gem "delayed_job", "~> 3.0.1"
+gem "delayed_job_active_record"
 gem "workless", "~> 1.0.1"
From a39cd4e1d02aa916c75f6e46d9b6b42a1f311907 Mon Sep 17 00:00:00 2001 From: Christopher Manning Date: Wed, 28 Mar 2012 14:58:35 -0500 Subject: [PATCH 4/4] Add note mentioning how you can use the API key in place of your heroku password. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b41064d..71cdf24 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,8 @@ gem "workless", "~> 1.0.1" If you don't specify delayed_job in your Gemfile workless will bring it in, most likly the latest version (3.0.1) -Add your Heroku username / password as config vars to your Heroku instance, the same one you log in to Heroku with +Add your Heroku username / password as config vars to your Heroku instance, the same one you log in to Heroku with. +[You may also use your API key as the password](https://github.com/heroku/heroku/issues/103). 
 heroku config:add HEROKU_USER=yourusername HEROKU_PASSWORD=yourpassword