Skip to content

Commit 6e0f7ce

Browse files
committed
Improve documentation
1 parent 72bd964 commit 6e0f7ce

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ Once [installed](#install), you can use the following code to access your local
8282
Asterisk instance and issue some simple commands via AMI:
8383

8484
```php
85+
<?php
86+
87+
require __DIR__ . '/vendor/autoload.php';
88+
8589
$factory = new Clue\React\Ami\Factory();
8690

8791
$factory->createClient('user:secret@localhost')->then(function (Clue\React\Ami\Client $client) {
@@ -546,7 +550,7 @@ This is a shortcut to get the value of the "Event" field.
546550

547551
## Install
548552

549-
The recommended way to install this library is [through Composer](https://getcomposer.org).
553+
The recommended way to install this library is [through Composer](https://getcomposer.org/).
550554
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
551555

552556
This project follows [SemVer](https://semver.org/).
@@ -560,12 +564,12 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
560564

561565
This project aims to run on any platform and thus does not require any PHP
562566
extensions and supports running on legacy PHP 5.3 through current PHP 8+.
563-
It's *highly recommended to use PHP 7+* for this project.
567+
It's *highly recommended to use the latest supported PHP version* for this project.
564568

565569
## Tests
566570

567571
To run the test suite, you first need to clone this repo and then install all
568-
dependencies [through Composer](https://getcomposer.org):
572+
dependencies [through Composer](https://getcomposer.org/):
569573

570574
```bash
571575
$ composer install
@@ -574,7 +578,7 @@ $ composer install
574578
To run the test suite, go to the project root and run:
575579

576580
```bash
577-
$ php vendor/bin/phpunit
581+
$ vendor/bin/phpunit
578582
```
579583

580584
The test suite contains both unit tests and functional integration tests.

0 commit comments

Comments
 (0)