README.md in songkick_queue-0.3.0 vs README.md in songkick_queue-0.4.0

- old
+ new

@@ -6,11 +6,11 @@ [![Build status](https://travis-ci.org/songkick/queue.svg?branch=master)](https://travis-ci.org/songkick/queue) ## Dependencies * Ruby 2.0+ -* RabbitMQ ~v2.8 +* RabbitMQ 3.3+ ## Installation Add this line to your application's Gemfile: @@ -28,22 +28,25 @@ ## Usage ### Setup -You must define both the AMQP URL and a logger instance: +Configure a logger and your AMQP connection settings as follows. The values defined below are the defaults: ```ruby SongkickQueue.configure do |config| - config.amqp = 'amqp://localhost:5672' # required - config.logger = Logger.new(STDOUT) # required - config.queue_namespace = ENV['RACK_ENV'] # optional + config.logger = Logger.new(STDOUT) + config.host = '127.0.0.1' + config.port = 5672 + config.username = 'guest' + config.password = 'guest' + config.vhost = '/' end ``` -You can also optionally define a namespace to apply to your queue names automatically when -publishing and consuming. This can be useful to isolate environments that share the same RabbitMQ -instance. +SongkickQueue should work out the box with a new, locally installed RabbitMQ instance. + +NB. The `vhost` option can be a useful way to isolate environments that share the same RabbitMQ instance (eg. staging and production). ### Creating consumers To create a consumer simply construct a new class and include the `SongkickQueue::Consumer` module.