Skip to content

Commit b8076bc

Browse files
committed
Minor documentation improvements
1 parent 8eef801 commit b8076bc

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ monitor the status of subscribers, channels or queues.
2222
and does not get in your way.
2323
Future or custom actions and events require no changes to be supported.
2424
* **Good test coverage** -
25-
Comes with an automated tests suite and is regularly tested against versions as old as Asterisk 1.8+ and newer.
25+
Comes with an automated tests suite and is regularly tested in the *real world*
26+
against current Asterisk versions and versions as old as Asterisk 1.8.
2627

2728
**Table of contents**
2829

@@ -64,15 +65,15 @@ monitor the status of subscribers, channels or queues.
6465
## Quickstart example
6566

6667
Once [installed](#install), you can use the following code to access your local
67-
Asterisk Telephony instance and issue some simple commands via AMI:
68+
Asterisk instance and issue some simple commands via AMI:
6869

6970
```php
7071
$loop = React\EventLoop\Factory::create();
7172
$factory = new Clue\React\Ami\Factory($loop);
7273

7374
$factory->createClient('user:secret@localhost')->then(function (Clue\React\Ami\Client $client) {
7475
echo 'Client connected' . PHP_EOL;
75-
76+
7677
$sender = new Clue\React\Ami\ActionSender($client);
7778
$sender->listCommands()->then(function (Clue\React\Ami\Protocol\Response $response) {
7879
echo 'Available commands:' . PHP_EOL;
@@ -308,9 +309,12 @@ Consider filing a PR to add new actions to the `ActionSender`.
308309

309310
#### Promises
310311

311-
Sending actions is async (non-blocking), so you can actually send multiple action requests in parallel.
312-
The AMI will respond to each action with a [`Response`](#response) object. The order is not guaranteed.
313-
Sending actions uses a [Promise](https://github.com/reactphp/promise)-based interface that makes it easy to react to when an action is completed
312+
Sending actions is async (non-blocking), so you can actually send multiple
313+
action requests in parallel.
314+
The AMI will respond to each action with a [`Response`](#response) object.
315+
The order is not guaranteed.
316+
Sending actions uses a [Promise](https://github.com/reactphp/promise)-based
317+
interface that makes it easy to react to when an action is completed
314318
(i.e. either successfully fulfilled or rejected with an error):
315319

316320
```php
@@ -340,7 +344,7 @@ object to contain a list of entries.
340344
As stated above, this library provides you a powerful, async API by default.
341345

342346
If, however, you want to integrate this into your traditional, blocking environment,
343-
you should look into also using [clue/block-react](https://github.com/clue/php-block-react).
347+
you should look into also using [clue/reactphp-block](https://github.com/clue/reactphp-block).
344348

345349
The resulting blocking code could look something like this:
346350

@@ -366,7 +370,7 @@ function getSipPeers()
366370
}
367371
```
368372

369-
Refer to [clue/block-react](https://github.com/clue/php-block-react#readme) for more details.
373+
Refer to [clue/reactphp-block](https://github.com/clue/reactphp-block#readme) for more details.
370374

371375
### Message
372376

0 commit comments

Comments
 (0)