diff --git a/README.md b/README.md index 9d44bf6a..83de3c8f 100644 --- a/README.md +++ b/README.md @@ -3,50 +3,48 @@ 1. Download and Install PHP Composer. -``` sh -curl -sS https://getcomposer.org/installer | php -``` + ``` sh + curl -sS https://getcomposer.org/installer | php + ``` 2. Next, run the Composer command to install the latest version of php jira rest client. - -``` sh -php composer.phar require lesstif/php-jira-rest-client dev-master -``` - -or add the following to your composer.json file. - -```json -{ - "require": { - "lesstif/php-jira-rest-client": "dev-master" - } -} -``` - + ``` sh + php composer.phar require lesstif/php-jira-rest-client dev-master + ``` + or add the following to your composer.json file. + ```json + { + "require": { + "lesstif/php-jira-rest-client": "dev-master" + } + } + ``` 3. Then run Composer's install or update commands to complete installation. -```sh -php composer.phar install -``` - + ```sh + php composer.phar install + ``` + 4. After installing, you need to require Composer's autoloader: -```php -require 'vendor/autoload.php'; -``` + ```php + require 'vendor/autoload.php'; + ``` + +# Configuration -5. create config.jira.json file on your project root. +create config.jira.json file on your project root. ````json { - "host": "https://jira.example.com", - "username": "username", - "password": "password", + "host": "https://your-jira.host.com", + "username": "jira-username", + "password": "jira-password", "CURLOPT_SSL_VERIFYHOST": false, "CURLOPT_SSL_VERIFYPEER": false, "CURLOPT_VERBOSE": false, "LOG_FILE": "jira-rest-client.log", - "LOG_LEVEL": "INFO" + "LOG_LEVEL": "WARNING" } ````