From e02c8b8bd7763ccb5a1973511785c59297399c3c Mon Sep 17 00:00:00 2001 From: aydiv Date: Thu, 8 Aug 2013 13:09:43 +0530 Subject: [PATCH] Removing coveralls from dev dependencies / updating composer instructions --- README.md | 36 ++++++++++++++++-------------------- composer.json | 3 +-- 2 files changed, 17 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 2dcdc6d..252eb9e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,32 @@ -REST API SDK for PHP -==================== +# REST API SDK for PHP + [![Build Status](https://travis-ci.org/paypal/rest-api-sdk-php.png?branch=master)](https://travis-ci.org/paypal/rest-api-sdk-php) [![Coverage Status](https://coveralls.io/repos/paypal/rest-api-sdk-php/badge.png?branch=master)](https://coveralls.io/r/paypal/rest-api-sdk-php?branch=master) [![Latest Stable Version](https://poser.pugx.org/paypal/rest-api-sdk-php/v/stable.png)](https://packagist.org/packages/paypal/rest-api-sdk-php) [![Total Downloads](https://poser.pugx.org/paypal/rest-api-sdk-php/downloads.png)](https://packagist.org/packages/paypal/rest-api-sdk-php) This repository contains PayPal's PHP SDK and samples for REST API. -Prerequisites -------------- +## Prerequisites * PHP 5.3 or above * curl, json & openssl extensions must be enabled * composer for running the sample out of the box (See http://getcomposer.org) -Running the sample ------------------- +## Running the sample * Ensure that you have composer installed on your machine. - * Navigate to the samples folder and run 'composer update'. + * Navigate to the samples folder and run 'composer update --no-dev'. * Optionally, update the bootstrap.php file with your own client Id and client secret. * Run any of the samples in the 'samples' folder to see what the APIs can do. -Usage ------ +## Usage To write an app that uses the SDK - * Copy the composer.json file from the sample folder over to your project and run 'composer update' to fetch all -dependencies - * Copy the sample configuration file sdk_config.ini to a location of your choice and let the SDK know your config path using the following define directive - + * Copy the composer.json file from the sample folder over to your project and run 'composer update --no-dev' to fetch all dependencies. + * Copy the sample configuration file sdk_config.ini to a location of your choice and let the SDK know your config path using the following define directive. + ```php define('PP_CONFIG_PATH', /path/to/your/sdk_config.ini); ``` @@ -40,7 +36,7 @@ dependencies ```php - $apiContext = new ApiContext(new OAuthTokenCredential('', '', '')); $payment = new Payment(); @@ -55,14 +51,14 @@ dependencies $payment = Payment::get('payment_id', $apiContext); ``` -These examples pick the SDK configuration from the sdk_config.ini file. If you do not want to use an ini file or want to pick your configuration dynamically, you can use the `$apiContext->setConfig()` method to pass in the configuration. +## SDK Configuration + +The samples in this repo pick the SDK configuration from the sdk_config.ini file. If you do not want to use an ini file or want to pick your configuration dynamically, you can use the `$apiContext->setConfig()` method to pass in the configuration as a hashmap. See the `sample/bootstrap.php` file for an example. -Contributing ------------- +## Contributing -More help ---------- +## More help * [API Reference](https://developer.paypal.com/webapps/developer/docs/api/) - * [Reporting issues / feature requests] (https://github.com/paypal/rest-api-sdk-php/issues) \ No newline at end of file + * [Reporting issues / feature requests] (https://github.com/paypal/rest-api-sdk-php/issues) diff --git a/composer.json b/composer.json index 20d7592..4f89af9 100644 --- a/composer.json +++ b/composer.json @@ -18,8 +18,7 @@ "paypal/sdk-core-php": "2.4.*" }, "require-dev": { - "phpunit/phpunit": "3.7.*", - "satooshi/php-coveralls": "dev-master" + "phpunit/phpunit": "3.7.*" }, "autoload": { "psr-0": {