README.md in karafka-sidekiq-backend-1.0.0.pre1 vs README.md in karafka-sidekiq-backend-1.0.0

- old
+ new

@@ -1,10 +1,11 @@ # Karafka Sidekiq Backend [![Build Status](https://travis-ci.org/karafka/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 provides support for processing received Kafka messages inside of Sidekiq workers. +[Karafka Sidekiq Backend](https://github.com/karafka/karafka-sidekiq-backend) provides support for processing received Kafka messages inside of Sidekiq workers. ## Installations Add this to your gemfile: @@ -19,11 +20,11 @@ end ``` and you are ready to go. Karafka Sidekiq Backend integrates with Karafka automatically -Note: You can name your application worker base class with any name you want. The only thing that is required is a direct inheritance from the ```Karafka::BaseWorker``` class. +**Note**: You can name your application worker base class with any name you want. The only thing that is required is a direct inheritance from the ```Karafka::BaseWorker``` class. ## Usage If you want to process messages with Sidekiq backend, you need to tell this to Karafka. @@ -110,5 +111,32 @@ topic :binary_video_details do controller Videos::DetailsController interchanger Base64Interchanger end ``` + +## References + +* [Karafka framework](https://github.com/karafka/karafka) +* [Karafka Sidekiq Backend Travis CI](https://travis-ci.org/karafka/karafka-sidekiq-backend) +* [Karafka Sidekiq Backend Coditsu](https://app.coditsu.io/karafka/repositories/karafka-sidekiq-backend) + +## Note on Patches/Pull Requests + +Fork the project. +Make your feature addition or bug fix. +Add tests for it. This is important so we don't break it in a future versions unintentionally. +Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull). Send me a pull request. Bonus points for topic branches. + +[![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka/repositories/karafka-sidekiq-backend) + +Each pull request must pass our quality requirements. To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combinse multiple linters and code analyzers for both code and documentation. + +Unfortunately, it does not yet support independent forks, however you should be fine by looking at what we require. + +Please run: + +```bash +bundle exec rake +``` + +to check if everything is in order. After that you can submit a pull request.