Updated README

Author: petermein

README.md

@@ -4,24 +4,42 @@ Kafka Queue driver for Laravel
 [![Build Status](https://travis-ci.org/rapideinternet/laravel-queue-kafka.svg?branch=master)](https://travis-ci.org/rapideinternet/laravel-queue-kafka)
 [![Total Downloads](https://poser.pugx.org/rapide/laravel-queue-kafka/downloads?format=flat-square)](https://packagist.org/packages/rapide/laravel-queue-kafka)
 [![StyleCI](https://styleci.io/repos/99249783/shield)](https://styleci.io/repos/99249783)
-[![License](https://poser.pugx.org/rapide/laravel-queue-kafka/license?format=flat-square)](https://packagist.org/packages/rapide/laravel-queue-kafka)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 #### Installation
 
-1. Install this package via composer using:
+1. Install [librdkafka c library](https://github.com/edenhill/librdkafka)
+
+    ```bash
+    $ cd /tmp
+    $ mkdir librdkafka
+    $ cd librdkafka
+    $ git clone https://github.com/edenhill/librdkafka.git .
+    $ ./configure
+    $ make
+    $ make install
+    ```
+2. Install the [php-rdkafka](https://github.com/arnaud-lb/php-rdkafka) PECL extension
+
+    ```bash
+    $ pecl install rdkafka
+    ```
+    
+3. Add the following to your php.ini file to enable the php-rdkafka extension
+    `extension=rdkafka.so`
+    
+4. Install this package via composer using:
 
 	`composer require rapide/laravel-queue-kafka`
 
-2. Add LaravelQueueKafkaServiceProvider to `providers` array in `config/app.php`:
+5. Add LaravelQueueKafkaServiceProvider to `providers` array in `config/app.php`:
 
 	`Rapide\LaravelQueueKafka\LaravelQueueKafkaServiceProvider::class,`
 
-3. Add these properties to `.env` with proper values:
+6. Add these properties to `.env` with proper values:
 
 		QUEUE_DRIVER=kafka
 
-You can also find full examples in src/examples folder.
-
 #### Usage
 
 Once you completed the configuration you can use Laravel Queue API. If you used other queue drivers you do not need to change anything else. If you do not know how to use Queue API, please refer to the official Laravel documentation: http://laravel.com/docs/queues
@@ -37,14 +55,12 @@ vendor/bin/phpunit
 #### Acknowledgement 
 
 This library is inspired by [laravel-queue-rabbitmq](https://github.com/vyuldashev/laravel-queue-rabbitmq) by vyuldashev.
-And the Kafka implementation by [https://github.com/Superbalist/php-pubsub-kafka](Superbalist) 
+And the Kafka implementations by [Superbalist](https://github.com/Superbalist/php-pubsub-kafka) be sure to check those out. 
 
 #### Contribution
 
 You can contribute to this package by discovering bugs and opening issues. Please, add to which version of package you create pull request or issue.
 
-#### Supported versions of Laravel (+Lumen)
-
-5.4
+#### Supported versions of Laravel 
 
-The version is being matched by the release tag of this library.
+Tested on: [5.4]

config/kafka.php

@@ -30,6 +30,6 @@
      * Determine the number of seconds to sleep if there's an error communicating with kafka
      * If set to false, it'll throw an exception rather than doing the sleep for X seconds.
      */
-    'sleep_on_error' => env('RABBITMQ_ERROR_SLEEP', 5),
+    'sleep_on_error' => env('KAFKA_ERROR_SLEEP', 5),
 
 ];