Skip to content

Commit e549580

Browse files
committed
Update README and add PHP 5.6+ constraint
1 parent d8d8d58 commit e549580

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,21 +72,26 @@ Either pull in the library via composer:
7272
$ composer require nicklaw5/twitch-api-php
7373

7474
```
75-
or add the following dependency to your `composer.json` file:
75+
76+
or add the following dependency to your `composer.json` file and run `composer install`:
7677

7778
```json
7879
"nicklaw5/twitch-api-php": "0.1.*"
7980
```
8081

81-
## Documentation
82+
## Tests
8283

83-
The API docs for each version can be found in their respective locations:
84+
All unit tests can be run with the following command:
85+
86+
```bash
87+
$ vendor/bin/phpunit # or simply "phpunit" if you have it installed globally
88+
```
89+
90+
## Documentation
8491

85-
- v3 docs can be found [here](https://dev.twitch.tv/docs/v3).
86-
- v4 was not officially documented by the Twicth staff. Mostly it incorporates the v3 API, but some documentation for the [Clips API](https://dev.twitch.tv/docs/v5/guides/clips-discovery/), for example, can be found on Twitch's developer website.
87-
- v5 docs can be found on the [Twitch's developer website](https://dev.twitch.tv/docs/).
92+
The Twitch API docs can be found [here](https://dev.twitch.tv/docs).
8893

89-
As for the documentation of this library, that is still on the to-do list. In the meantime, most modern IDEs by default or through the use of plugins, will provide class property and method auto-completion. Or you can simple look through the [source](src) code.
94+
As for the documentation of this library, that is still on the to-do list. In the meantime, most modern IDEs by default, or through the use of plugins, will provide class property and method auto-completion. Or you can simple look through the [source](src) code.
9095

9196
## License
9297

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
}
1313
],
1414
"require": {
15+
"php": ">=5.6.0",
1516
"guzzlehttp/guzzle": "~6.0"
1617
},
1718
"require-dev": {

0 commit comments

Comments
 (0)