Skip to content

Commit f7e1887

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents af9b527 + b18f68e commit f7e1887

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ RoadRunner
88
[![Codecov](https://codecov.io/gh/spiral/roadrunner/branch/master/graph/badge.svg)](https://codecov.io/gh/spiral/roadrunner/)
99

1010
RoadRunner is an open source (MIT licensed), high-performance PSR-7 PHP application server, load balancer and process manager.
11-
It supports service model with ability to extend it's functionality on a project basis.
11+
It supports running as a service with the ability to extend its functionality on a per-project basis.
1212

1313
Features:
1414
--------
@@ -24,7 +24,7 @@ Features:
2424
- control over max jobs per worker
2525
- protocol, worker and job level error management (including PHP errors)
2626
- memory leak failswitch
27-
- very fast (~250k rpc calls per second on Ryzen 1700X over 16 threads)
27+
- very fast (~250k rpc calls per second on Ryzen 1700X using 16 threads)
2828
- works on Windows
2929

3030
Getting Started:
@@ -52,7 +52,7 @@ $ make test
5252
Using RoadRunner:
5353
--------
5454

55-
In order to use RoadRunner you only have to place `.rr.yaml` file in a root of your php project:
55+
In order to use RoadRunner you only have to place a `.rr.yaml` config file in the root of your PHP project:
5656

5757
```yaml
5858
# rpc bus allows php application and external clients to talk to rr services.
@@ -152,7 +152,7 @@ You can also run RR in debug mode to view all incoming requests.
152152
$ rr serve -d -v
153153
```
154154
155-
You can force RR service to reload it's http workers.
155+
You can force RR service to reload its http workers.
156156
157157
```
158158
$ rr http:reset
@@ -179,9 +179,9 @@ $ rr http:workers -i
179179
180180
Writing Services:
181181
--------
182-
RoadRunner uses service bus to organize it's internal services and their depencies, this approach is similar to PHP Container implementation. You can create your own services, event listeners, middlewares and etc.
182+
RoadRunner uses a service bus to organize its internal services and their dependencies, this approach is similar to the PHP Container implementation. You can create your own services, event listeners, middlewares, etc.
183183
184-
RoadRunner would not start service without a proper config section at the moment, simply add new section to .rr file.
184+
RoadRunner will not start as a service without a proper config section at the moment. To do this, simply add the following section section to your `.rr.yaml` file.
185185
186186
```yaml
187187
service:
@@ -200,7 +200,7 @@ type config struct {
200200
}
201201
```
202202

203-
To create the service implement interface:
203+
To create the service, implement this interface:
204204

205205
```golang
206206
// Service provides high level functionality for road runner modules.
@@ -217,7 +217,7 @@ type Service interface {
217217
}
218218
```
219219

220-
Simple service might look like:
220+
A simple service might look like this:
221221

222222
```golang
223223
package service
@@ -259,7 +259,7 @@ Service can be added to RR bus by creating your own version of [main.go](https:/
259259
rr.Container.Register(service.ID, &service.Service{})
260260
```
261261

262-
Your service should work now. In addition you can create your own RPC adapters which are available via commands or from PHP using Goridge:
262+
Your service should now work. In addition, you can create your own RPC adapters which are available via commands or from PHP using Goridge:
263263

264264
```golang
265265
// in Init() method
@@ -272,7 +272,7 @@ if r, ok := c.Get(rpc.ID); ok >= service.StatusConfigured {
272272

273273
> RPC server must be written based on net/rpc rules: https://golang.org/pkg/net/rpc/
274274
275-
You can connect now to this service from PHP:
275+
You can now connect to this service from PHP:
276276

277277
```php
278278
// make sure to use same port as in .rr config for RPC service
@@ -281,14 +281,14 @@ $rpc = new Spiral\Goridge\RPC(new Spiral\Goridge\SocketRelay('localhost', 6001))
281281
print_r($rpc->call('service.Method', $ars));
282282
```
283283

284-
HTTP service provides it's own methods as well:
284+
HTTP service provides its own methods as well:
285285

286286
```php
287287
print_r($rpc->call('http.Workers', true));
288288
//print_r($rpc->call('http.Reset', true));
289289
```
290290

291-
You can register http middleware or event listener using such approach:
291+
You can register http middleware or event listener using this approach:
292292

293293
```golang
294294
import (
@@ -307,7 +307,7 @@ if h, ok := c.Get(rrttp.ID); ok >= service.StatusConfigured {
307307

308308
Standalone Usage:
309309
--------
310-
You can also use RoadRunner as library in order to drive your application without any additional protocol at top of it.
310+
You can also use RoadRunner as a library in order to drive your application without any additional protocol on top of it.
311311

312312
```go
313313
srv := NewServer(

0 commit comments

Comments
 (0)