Skip to content
This repository was archived by the owner on Oct 3, 2018. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
elskwid committed Nov 22, 2012
1 parent ad90c16 commit 2f52c09
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ The Thincloud::Resque engine:

* Manages all of the Resque (and Redis) dependencies for your application
* Initializes the Redis connection and namespace for Resque
* Configures the Resque Front End to use HTTP Basic authentication
* Configures the Resque Front End (resque-web) to use HTTP Basic authentication
* Optionally configures `resque_mailer`
* Provides a generator to add a Capistrano recipe and a Procfile entry
* Provides a Capistrano recipe to link resque-web assets during deployment


## Requirements

Expand Down Expand Up @@ -103,35 +104,34 @@ Resque::Mailer is enabled for environments included in the `mailer_environments`
config.mailer_environments = []
```

and add the following line to those mailers:
and, for those mailers that need to background email, add the following line:

```ruby
include Resque::Mailer
```

#### Routes

Resque has a built-in Front End Sinatra server that provides access to monitor the server's status. To allow access to the Front End through your app you need to mount the engine in `config/routes.rb`:
Resque has a built-in Front End Sinatra (resque-web) server that provides access to monitor the Resque server's status. To allow access to the Front End through your app you need to mount the engine in `config/routes.rb`:

```ruby
mount Thincloud::Resque::Engine => "/resque"
```
=> `http://yourapp/resque`

The Front End would be available at `http://yourapp/resque`

Call this inside a namespace to give a nested route as well:
Call this inside a namespace to create a nested route if needed:

```ruby
namespace :admin do
mount Thincloud::Resque::Engine => "/resque"
end
```

The Front End would be available at `http://yourapp/admin/resque`
=> `http://yourapp/admin/resque`

#### Capistrano

To make Resque web assets available to the released application add the following line to your `deploy.rb` or `Capfile`:
To make resque-web assets available to the released application, add the following line to your `deploy.rb` or `Capfile`:

```ruby
require "thincloud/resque/capistrano"
Expand Down

0 comments on commit 2f52c09

Please sign in to comment.