Skip to content

Commit 6d414a0

Browse files
authored
Merge branch 'main' into dev
2 parents bf713ad + cf930fc commit 6d414a0

File tree

3 files changed

+37
-5
lines changed

3 files changed

+37
-5
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ vendor/
66
phpunit.xml
77
sample/*/vendor/
88
sample/*/cache/
9-
composer.lock
10-
119
docs/
1210
.phpdoc/
1311
phpDocumentor*
1412
.phpunit.result.cache
13+
.idea/*

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ The OpenTok PHP SDK provides methods for:
2323

2424
Composer helps manage dependencies for PHP projects. Find more info here: <http://getcomposer.org>
2525

26-
Add this package (`opentok/opentok`) to your `composer.json` file, or just run the following at the
26+
Add this package (`opentok/opentok`) to your `composer.json` file, or run the following at the
2727
command line:
2828

29-
```
30-
$ ./composer.phar require opentok/opentok ^4.0
29+
```bash
30+
$ composer require opentok/opentok ^4.0
3131
```
3232

3333
## Usage
@@ -512,6 +512,34 @@ See the reference documentation
512512
<http://www.tokbox.com/opentok/libraries/server/php/reference/index.html> and in the
513513
docs directory of the SDK.
514514

515+
## Running code quality tooling
516+
517+
This library makes use of two code quality tools, plus a full PHPUnit test suite.
518+
519+
* [phpcs](https://github.com/squizlabs/PHP_CodeSniffer)
520+
521+
To run phpcs, enter the following on the command line:
522+
523+
```bash
524+
$ composer run phpcs
525+
```
526+
527+
* [phpstan](https://github.com/phpstan/phpstan)
528+
529+
To run phpstan, enter the following on the command line:
530+
531+
```bash
532+
$ composer run phpstan
533+
```
534+
535+
* [phpunit](https://phpunit.de/)
536+
537+
To run PhpUnit, enter the following on the command line:
538+
539+
```bash
540+
$ composer run test
541+
```
542+
515543
## Development and Contributing
516544

517545
Interested in contributing? We :heart: pull requests! See the [Development](DEVELOPING.md) and

composer.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
"rector/rector": "^0.8",
4646
"phing/phing": "~2.16.0"
4747
},
48+
"scripts": {
49+
"phpstan": "./vendor/bin/phpstan",
50+
"phpcs": "./vendor/bin/phpcs",
51+
"test": "./vendor/bin/phpunit --testdox"
52+
},
4853
"autoload": {
4954
"psr-4": {
5055
"OpenTok\\": "src/OpenTok",

0 commit comments

Comments
 (0)