README.md in karafka-sidekiq-backend-1.2.0.beta3 vs README.md in karafka-sidekiq-backend-1.2.0.beta4
- old
+ new
@@ -1,11 +1,11 @@
# Karafka Sidekiq Backend
-[![Build Status](https://travis-ci.org/karafka/karafka-sidekiq-backend.png)](https://travis-ci.org/karafka/karafka-sidekiq-backend)
+[![Build Status](https://travis-ci.org/karafka/sidekiq-backend.png)](https://travis-ci.org/karafka/karafka-sidekiq-backend)
[![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[Karafka Sidekiq Backend](https://github.com/karafka/karafka-sidekiq-backend) provides support for consuming (processing) received Kafka messages inside of Sidekiq workers.
+[Karafka Sidekiq Backend](https://github.com/karafka/sidekiq-backend) provides support for consuming (processing) received Kafka messages inside of Sidekiq workers.
## Installations
Add this to your gemfile:
@@ -45,11 +45,11 @@
App.routes.draw do
consumer_group :videos_consumer do
topic :binary_video_details do
controller Videos::DetailsController
worker Workers::DetailsWorker
- interchanger Interchangers::Binary
+ interchanger Interchangers::MyCustomInterchanger
end
end
end
```
@@ -60,10 +60,10 @@
There are two options you can set inside of the ```topic``` block:
| Option | Value type | Description |
|--------------|------------|-------------------------------------------------------------------------------------------------------------------|
| worker | Class | Name of a worker class that we want to use to schedule perform code |
-| interchanger | Class | Name of a parser class that we want to use to parse incoming data |
+| interchanger | Class | Name of an interchanger class that we want to use to pass the incoming data to Sidekiq |
### Workers
Karafka by default will build a worker that will correspond to each of your controllers (so you will have a pair - controller and a worker). All of them will inherit from ```ApplicationWorker``` and will share all its settings.