Skip to content

Commit 39d328e

Browse files
committed
First Readme fix iteration
1 parent 1d6b420 commit 39d328e

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,31 @@ Easy way for connecting [RoadRunner][roadrunner] and [Laravel][laravel] applicat
1212

1313
## Why Use This Package?
1414

15-
Laravel provides the [Octane](https://laravel.com/docs/12.x/octane) package which partially supports RoadRunner as an
16-
application server, but RoadRunner offers much more than just HTTP capabilities. It also includes Jobs, Temporal, gRPC,
17-
and other plugins.
15+
This library offers the most complete integration of Laravel with RoadRunner.
16+
You should definitely use this package if:
1817

19-
![RoadRunner](https://github.com/user-attachments/assets/609d2e29-b6af-478b-b350-1d27b77ed6fb)
18+
- You want to use not only HTTP but also other RoadRunner plugins like gRPC, Queue, KV, and others.
19+
- You want to use Temporal.
20+
- You want to control RoadRunner configuration.
2021

21-
> **Note:** There is an article that explains all the RoadRunner
22-
> plugins: https://butschster.medium.com/roadrunner-an-underrated-powerhouse-for-php-applications-46410b0abc
22+
![RoadRunner](https://github.com/user-attachments/assets/609d2e29-b6af-478b-b350-1d27b77ed6fb)
2323

24-
The main limitation of Octane is that it has a built-in worker only for the HTTP plugin and doesn't provide the ability
25-
to create additional workers for other RoadRunner plugins, restricting its use to just the HTTP plugin.
24+
> [!TIP]
25+
> [There is an article][rr-plugins-article] that explains all the RoadRunner plugins:
2626
27-
Our **Laravel Bridge** solves this problem by taking a different approach:
2827

29-
1. We include `laravel/octane` in our package and reuse its **SDK** for clearing the state of Laravel applications
30-
2. We add support for running and configuring multiple workers for different RoadRunner plugins
31-
3. By reusing Octane's functionality for state clearing, we automatically support all third-party packages that are
32-
compatible with Octane
28+
Table of content:
3329

34-
**This way, you get the best of both worlds:** Octane's state management and RoadRunner's full plugin ecosystem.
30+
- [Installation](#installation)
31+
- [Usage](#usage)
32+
- [RoadRunner Worker Configuration](#roadrunner-worker-configuration)
33+
- [How It Works](#how-it-works)
34+
- [Supported Plugins](#supported-plugins)
35+
- [HTTP Plugin](#http-plugin)
36+
- [Jobs (Queue) Plugin](#jobs-queue-plugin)
37+
- [gRPC Plugin](#grpc-plugin)
38+
- [Temporal](#temporal)
39+
- [Custom Workers]
3540

3641
## Installation
3742

@@ -65,7 +70,7 @@ rpc:
6570

6671
server:
6772
command: 'php vendor/bin/rr-worker start'
68-
relay: pipes
73+
relay: pipes
6974

7075
http:
7176
address: 0.0.0.0:8080
@@ -389,3 +394,7 @@ MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
389394
[laravel_events]:https://laravel.com/docs/events
390395

391396
[roadrunner-binary-releases]:https://github.com/roadrunner-server/roadrunner/releases
397+
398+
[octane]https://laravel.com/docs/12.x/octane
399+
400+
[rr-plugins-article]https://butschster.medium.com/roadrunner-an-underrated-powerhouse-for-php-applications-46410b0abc

0 commit comments

Comments
 (0)