diff --git a/doc/index.md b/doc/index.md index 8e7291c..0d70871 100644 --- a/doc/index.md +++ b/doc/index.md @@ -13,8 +13,8 @@ Perform the following steps to install and use the basic functionality of the On Download the bundle via composer: -``` -$> php composer.phar require oneup/flysystem-bundle +```sh +composer require oneup/flysystem-bundle ``` Composer will now fetch and install this bundle in the vendor directory `vendor/oneup` diff --git a/doc/tests.md b/doc/tests.md index 4ea7bbb..d215c0b 100644 --- a/doc/tests.md +++ b/doc/tests.md @@ -3,23 +3,33 @@ Testing the Bundle In order to run the UnitTests of this bundle, clone it first - $> git clone git://github.com/1up-lab/OneupFlysystemBundle.git +```sh +git clone git://github.com/1up-lab/OneupFlysystemBundle.git +``` After the cloning process, install all vendors by running the corresponding composer command. - $> composer install --dev +```sh +composer install --dev +``` ## Run PHPUnit -You can run the unit tests by simply performing the follwowing command: +You can run the unit tests by simply performing the following command: - $> vendor/bin/phpunit +```sh +git vendor/bin/phpunit +``` ## Run PHPStan -You can run the static php analyzer by simply performing the follwowing command: +You can run the static php analyzer by simply performing the following command: - $> vendor/bin/phpstan analyze src/ tests/ --level=max +```sh +vendor/bin/phpstan analyze src/ tests/ --level=max +``` ## Run php-cs-fixer -You can run the php code style fixer by simply performing the follwowing command: +You can run the php code style fixer by simply performing the following command: - $> vendor/bin/php-cs-fixer fix +```sh +vendor/bin/php-cs-fixer fix +```