Skip to content

Commit af87a04

Browse files
committed
Fourth Readme fix iteration
1 parent e4525f8 commit af87a04

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,14 @@ server:
106106
command: 'php vendor/bin/rr-worker start'
107107
```
108108
109-
When RoadRunner creates a worker pool for a specific plugin, it sets the `RR_MODE` environment variable to indicate which plugin is being used.
110-
The Laravel Bridge checks this variable to determine which Worker class should handle the request based on your configuration.
109+
When RoadRunner creates a worker pool for a specific plugin,
110+
it sets the `RR_MODE` environment variable to indicate which plugin is being used.
111+
The Laravel Bridge checks this variable to determine
112+
which Worker class should handle the request based on your configuration.
111113

112-
The selected worker then listens for requests from the RoadRunner server and handles them using the Octane worker, which clears the application state after each task (request, command, etc.).
114+
The selected worker then listens for requests from the RoadRunner server
115+
and handles them using the [Octane][octane] worker,
116+
which clears the application state after each task (request, command, etc.).
113117

114118
## Supported Plugins
115119

@@ -132,11 +136,13 @@ http:
132136
forbid: [ ".php" ]
133137
```
134138

135-
> **Note:** Read more about the HTTP plugin in the [RoadRunner documentation](https://docs.roadrunner.dev/docs/http/http).
139+
> [!TIP]
140+
> Read more about the HTTP plugin in the [RoadRunner documentation][roadrunner-docs-http].
136141

137142
### Jobs (Queue) Plugin
138143

139-
The Queue plugin allows you to use RoadRunner as a queue driver for Laravel without additional services like Redis or a database.
144+
The Queue plugin allows you to use RoadRunner as a queue driver for Laravel
145+
without additional services like Redis or a database.
140146

141147
#### Configuration
142148

@@ -184,7 +190,7 @@ QUEUE_CONNECTION=roadrunner
184190
That's it! You can now dispatch jobs to the RoadRunner queue without any additional services like Redis or Database.
185191

186192
> [!TIP]
187-
> Read more about the Jobs plugin in the [RoadRunner documentation](https://docs.roadrunner.dev/docs/queues-and-jobs/overview-queues).
193+
> Read more about the Jobs plugin in the [RoadRunner documentation][roadrunner-docs-jobs].
188194

189195
### gRPC Plugin
190196

@@ -273,7 +279,8 @@ This section explains how to create and register custom workers in your applicat
273279

274280
### Understanding Workers
275281

276-
Workers are responsible for handling requests from the RoadRunner server and processing them in your Laravel application.
282+
Workers are responsible for handling requests from the RoadRunner server
283+
and processing them in your Laravel application.
277284
The predefined workers are configured in the `config/roadrunner.php` file:
278285

279286
```php
@@ -304,7 +311,8 @@ class CustomWorker implements WorkerInterface
304311
{
305312
public function start(WorkerOptionsInterface $options): void
306313
{
307-
// Your custom worker implementation
314+
// Your worker implementation goes here
315+
// This method should handle requests from the RoadRunner server
308316
}
309317
}
310318
```
@@ -328,15 +336,21 @@ return [
328336
];
329337
```
330338

339+
The key in the `workers` array should match the value of the `RR_MODE` environment variable
340+
set by the RoadRunner server for your plugin.
341+
331342
## Support
332343

333-
If you find this package helpful, please consider giving it a star on GitHub. Your support helps make the project more visible to other developers who might benefit from it!
344+
If you find this package helpful, please consider giving it a star on GitHub.
345+
Your support helps make the project more visible to other developers who might benefit from it!
334346

335347
[![Issues][badge_issues]][link_issues]
336348
[![Issues][badge_pulls]][link_pulls]
337349

338350
If you find any package errors, please, [make an issue][link_create_issue] in a current repository.
339351

352+
You can also [sponsor this project][link_sponsor] to help ensure its continued development and maintenance.
353+
340354
## License
341355

342356
MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
@@ -383,6 +397,8 @@ MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
383397

384398
[link_pulls]:https://github.com/roadrunner-php/laravel-bridge/pulls
385399

400+
[link_sponsor]:https://github.com/sponsors/roadrunner-server
401+
386402
[link_license]:https://github.com/roadrunner-php/laravel-bridge/blob/master/LICENSE
387403

388404
[getcomposer]:https://getcomposer.org/download/
@@ -399,6 +415,10 @@ MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
399415

400416
[roadrunner-binary-releases]:https://github.com/roadrunner-server/roadrunner/releases
401417

418+
[roadrunner-docs-jobs]:https://docs.roadrunner.dev/docs/queues-and-jobs/overview-queues
419+
420+
[roadrunner-docs-http]:https://docs.roadrunner.dev/docs/http/http
421+
402422
[octane]:https://laravel.com/docs/12.x/octane
403423

404424
[rr-plugins-article]:https://butschster.medium.com/roadrunner-an-underrated-powerhouse-for-php-applications-46410b0abc

0 commit comments

Comments
 (0)