File tree Expand file tree Collapse file tree 3 files changed +37
-5
lines changed Expand file tree Collapse file tree 3 files changed +37
-5
lines changed Original file line number Diff line number Diff line change 66phpunit.xml
77sample /* /vendor /
88sample /* /cache /
9- composer.lock
10-
119docs /
1210.phpdoc /
1311phpDocumentor *
1412.phpunit.result.cache
13+ .idea /*
Original file line number Diff line number Diff line change @@ -23,11 +23,11 @@ The OpenTok PHP SDK provides methods for:
2323
2424Composer 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
2727command 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
513513docs 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
517545Interested in contributing? We :heart : pull requests! See the [ Development] ( DEVELOPING.md ) and
Original file line number Diff line number Diff line change 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" ,
You can’t perform that action at this time.
0 commit comments