Skip to content

Commit b851554

Browse files
authored
Merge pull request #18 from yadaiio/Improve_test_suite
Improve documentation
2 parents d450aad + cade624 commit b851554

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# clue/arguments
22

3-
[![CI status](https://github.com/clue/arguments/workflows/CI/badge.svg)](https://github.com/clue/arguments/actions)
3+
[![CI status](https://github.com/clue/arguments/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/arguments/actions)
44
[![installs on Packagist](https://img.shields.io/packagist/dt/clue/arguments?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/arguments)
55

66
The simple way to split your command line string into an array of command arguments in PHP.
@@ -45,6 +45,10 @@ command line from user input (via `STDIN`) and then executes some very simple
4545
demo commands:
4646

4747
```php
48+
<?php
49+
50+
require __DIR__ . '/vendor/autoload.php';
51+
4852
while (true) {
4953
$line = fgets(STDIN, 1024);
5054

@@ -63,7 +67,7 @@ while (true) {
6367
}
6468
```
6569

66-
See also the [examples](examples).
70+
See also the [examples](examples/).
6771

6872
## Usage
6973

@@ -241,29 +245,29 @@ This project follows [SemVer](https://semver.org/).
241245
This will install the latest supported version:
242246

243247
```bash
244-
$ composer require clue/arguments:^2.1
248+
composer require clue/arguments:^2.1
245249
```
246250

247251
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
248252

249253
This project aims to run on any platform and thus does not require any PHP
250254
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
251255
HHVM.
252-
It's *highly recommended to use PHP 7+* for this project.
256+
It's *highly recommended to use the latest supported PHP version* for this project.
253257

254258
## Tests
255259

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

259263
```bash
260-
$ composer install
264+
composer install
261265
```
262266

263267
To run the test suite, go to the project root and run:
264268

265269
```bash
266-
$ php vendor/bin/phpunit
270+
vendor/bin/phpunit
267271
```
268272

269273
## License

0 commit comments

Comments
 (0)