README.md in insque-0.5.2 vs README.md in insque-0.6.0
- old
+ new
@@ -2,11 +2,11 @@
Instant queue. Background processing and message driven communication tool. Faster and simplier alternative to Resque.
## Installation
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
gem 'insque'
And then execute:
@@ -27,16 +27,23 @@
To broadcast message use:
```ruby
Insque.broadcast :message_name, {:params => {:some => :params}}
```
-There is an easy way to use insque as background jobs processing. You can use `send_later` method to call any method of your rails models in background
-. You still need listener running to make this work.
+There is an easy way to use insque as background jobs processing. You can use `send_later` method to call any method of your rails models in background:
```ruby
@model = MyModel.first
@model.send_later :mymethod, 'some', 'params'
```
+You'll need a special slow listener running to make this work.
+```ruby
+Insque.slow_listen
+```
+there is a matching slow janitor as well:
+```ruby
+Insque.slow_janitor
+```
### Recieving
To start recieving messages you need to:
@@ -59,31 +66,17 @@
Insque.janitor
```
or just run `bundle exec rake insque:janitor` from your console.
-### Slow Queue and send_later
+### Run All At Once
-Insque can be used for processing slow tasks in background. Slow tasks created with send_later method call of any ActiveRecord model:
-```ruby
-User.send_later :some_slow_method
-```
-and processed by a special slow listener:
-```ruby
-Insque.slow_listen
-```
-there is matching slow janitor as well:
-```ruby
-Insque.slow_janitor
-```
-### insque:run
-
There is a simple way to run all insque workers, both regular and slow in a single multi-threaded process:
```ruby
bundle exec rake insque:run
```
-### RedisCluster support
+### Redis Cluster Support
To make insque run on Redis Cluster add this line to your application's `Gemfile`:
gem 'redis_cluster'