README.md in phobos-2.0.2 vs README.md in phobos-2.1.0
- old
+ new
@@ -402,14 +402,17 @@
All [options supported by `ruby-kafka`][ruby-kafka-client] can be provided.
__producer__ provides configurations for all producers created over the application,
the options are the same for regular and async producers.
All [options supported by `ruby-kafka`][ruby-kafka-producer] can be provided.
+If the __kafka__ key is present under __producer__, it is merged into the top-level __kafka__, allowing different connection configuration for producers.
__consumer__ provides configurations for all consumer groups created over the application.
All [options supported by `ruby-kafka`][ruby-kafka-consumer] can be provided.
+If the __kafka__ key is present under __consumer__, it is merged into the top-level __kafka__, allowing different connection configuration for consumers.
+
__backoff__ Phobos provides automatic retries for your handlers. If an exception
is raised, the listener will retry following the back off configured here.
Backoff can also be configured per listener.
__listeners__ is the list of listeners configured. Each listener represents a consumer group.
@@ -580,11 +583,14 @@
After checking out the repo:
* make sure `docker` is installed and running (for windows and mac this also includes `docker-compose`).
* Linux: make sure `docker-compose` is installed and running.
* run `bin/setup` to install dependencies
-* run `docker-compose up` to start the required kafka containers in a window
-* run `rspec` to run the tests in another window
+* run `docker-compose up -d --force-recreate kafka zookeeper` to start the required kafka containers
+* run tests to confirm no environmental issues
+ * wait a few seconds for kafka broker to get set up - `sleep 30`
+ * run `docker-compose run --rm test`
+ * make sure it reports `X examples, 0 failures`
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).