diff --git a/modules/swagger-codegen/src/main/resources/php/README.mustache b/modules/swagger-codegen/src/main/resources/php/README.mustache index 17714beef6f..4088ddf1fbe 100644 --- a/modules/swagger-codegen/src/main/resources/php/README.mustache +++ b/modules/swagger-codegen/src/main/resources/php/README.mustache @@ -3,7 +3,7 @@ {{{appDescription}}} {{/appDescription}} -This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: +This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API verion: {{appVersion}} - Package version: {{artifactVersion}} @@ -20,7 +20,7 @@ PHP 5.4.0 and later ## Installation & Usage ### Composer -You can install the bindings via [Composer](http://getcomposer.org/). Add this to your `composer.json`: +To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: ``` { @@ -36,11 +36,12 @@ You can install the bindings via [Composer](http://getcomposer.org/). Add this t } ``` -Then install via `composer install` +Then run `composer install` ### Manual Installation -If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the `autoload.php` file. +Download the files and include `autoload.php`: + ```php require_once('/path/to/{{packagePath}}/autoload.php'); ``` @@ -48,6 +49,7 @@ If you do not wish to use Composer, you can download the latest release. Then, t ## Tests To run the unit tests: + ``` composer install ./vendor/bin/phpunit lib/Tests @@ -55,7 +57,7 @@ composer install ## Getting Started -Please follow the installation procedure and then run the following: +Please follow the [installation procedure](#installation--usage) and then run the following: ```php http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters -This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: +This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API verion: 1.0.0 - Package version: 1.0.0 -- Build date: 2016-03-19T15:53:20.386+08:00 +- Build date: 2016-03-19T16:11:03.465+08:00 - Build package: class io.swagger.codegen.languages.PhpClientCodegen ## Requirements @@ -15,7 +15,7 @@ PHP 5.4.0 and later ## Installation & Usage ### Composer -You can install the bindings via [Composer](http://getcomposer.org/). Add this to your `composer.json`: +To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: ``` { @@ -31,11 +31,12 @@ You can install the bindings via [Composer](http://getcomposer.org/). Add this t } ``` -Then install via `composer install` +Then run `composer install` ### Manual Installation -If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the `autoload.php` file. +Download the files and include `autoload.php`: + ```php require_once('/path/to/SwaggerClient-php/autoload.php'); ``` @@ -43,6 +44,7 @@ If you do not wish to use Composer, you can download the latest release. Then, t ## Tests To run the unit tests: + ``` composer install ./vendor/bin/phpunit lib/Tests @@ -50,7 +52,7 @@ composer install ## Getting Started -Please follow the installation procedure and then run the following: +Please follow the [installation procedure](#installation--usage) and then run the following: ```php