Skip to content

Commit dfc7812

Browse files
authored
Update README.md
1 parent f73637f commit dfc7812

File tree

1 file changed

+16
-27
lines changed

1 file changed

+16
-27
lines changed

README.md

Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ RabbitMQ Queue driver for Laravel
66
[![StyleCI](https://styleci.io/repos/14976752/shield)](https://styleci.io/repos/14976752)
77
[![License](https://poser.pugx.org/vladimir-yuldashev/laravel-queue-rabbitmq/license?format=flat-square)](https://packagist.org/packages/vladimir-yuldashev/laravel-queue-rabbitmq)
88

9-
#### Installation
9+
## Installation
1010

11-
1. Install this package via composer using:
11+
You can install this package via composer using this command:
1212

1313
```
1414
composer require vladimir-yuldashev/laravel-queue-rabbitmq
1515
```
1616

17-
2. Add these properties to `.env` with proper values:
17+
The package will automatically register itself.
18+
19+
Add these properties to `.env` with proper values:
1820

1921
```
2022
QUEUE_DRIVER=rabbitmq
@@ -30,7 +32,7 @@ RABBITMQ_PASSWORD=guest
3032
RABBITMQ_QUEUE=queue_name
3133
```
3234

33-
3. Optionally: if you want to to use an SSL connection, add these properties to the `.env` with proper values:
35+
Optionally, if you want to to use an SSL connection, add these properties to the `.env` with proper values:
3436
```
3537
RABBITMQ_SSL=true
3638
RABBITMQ_SSL_CAFILE=/path_to_your_ca_file
@@ -41,55 +43,42 @@ RABBITMQ_SSL_KEY=
4143

4244
Using an SSL connection will also require to configure your RabbitMQ to enable SSL. More details can be founds here: https://www.rabbitmq.com/ssl.html
4345

44-
4. Other AMQP transports
46+
## Using AMQP transports
4547

4648
The package uses [enqueue/amqp-lib](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/transport/amqp_lib.md) transport which is based on [php-amqplib](https://github.com/php-amqplib/php-amqplib).
4749
There is possibility to use any [amqp interop](https://github.com/queue-interop/queue-interop#amqp-interop) compatible transport, for example `enqueue/amqp-ext` or `enqueue/amqp-bunny`.
4850
Here's an example on how one can change the transport to `enqueue/amqp-bunny`.
4951

50-
First, install the package:
52+
First, install desired transport package:
5153

5254
```bash
53-
$ composer require enqueue/amqp-bunny:^0.8
55+
composer require enqueue/amqp-bunny:^0.8
5456
```
5557

56-
and change the factory class:
58+
Change the factory class in `config/queue.php`:
5759

5860
```php
59-
<?php
60-
// config/queue.php
61-
62-
return [
61+
...
6362
'connections' => [
6463
'rabbitmq' => [
6564
'driver' => 'rabbitmq',
66-
'factory_class' => \Enqueue\AmqpBunny\AmqpConnectionFactory::class,
65+
'factory_class' => Enqueue\AmqpBunny\AmqpConnectionFactory::class,
6766
],
6867
],
69-
];
7068
```
7169

72-
#### Usage
70+
## Usage
7371

7472
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
7573

76-
#### Testing
74+
## Testing
7775

78-
Run the tests with:
76+
You can run the tests with:
7977

8078
``` bash
8179
vendor/bin/phpunit
8280
```
8381

84-
85-
#### Contribution
82+
## Contribution
8683

8784
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. (e.g. [5.2] Fatal error on delayed job)
88-
89-
> If you want to make feature for several versions (for example: 5.2, 5.3, 5.4 and 5.5). Create PR for the lowest version (5.2). Hence, you should use branch v5.2.
90-
91-
#### Supported versions of Laravel (+Lumen)
92-
93-
`4.0, 4.1, 4.2, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5`
94-
95-
The version is being matched by the release tag of this library.

0 commit comments

Comments
 (0)