externals/stripe-php/README.rdoc

   1 = Stripe PHP bindings
   2 {<img src="https://travis-ci.org/stripe/stripe-php.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/stripe/stripe-php]
   3 {<img src="https://poser.pugx.org/stripe/stripe-php/v/stable.svg" alt="Latest Stable Version" />}[https://packagist.org/packages/stripe/stripe-php]
   4 {<img src="https://poser.pugx.org/stripe/stripe-php/downloads.svg" alt="Total Downloads" />}[https://packagist.org/packages/stripe/stripe-php]
   5 {<img src="https://poser.pugx.org/stripe/stripe-php/license.svg" alt="License" />}[https://packagist.org/packages/stripe/stripe-php]
   6
   7 You can sign up for a Stripe account at https://stripe.com.
   8
   9 == Requirements
  10
  11 PHP 5.2 and later.
  12
  13 == Composer
  14
  15 You can install the bindings via Composer[http://getcomposer.org/]. Add this to your +composer.json+:
  16
  17     {
  18       "require": {
  19         "stripe/stripe-php": "1.*"
  20       }
  21     }
  22
  23 Then install via:
  24
  25     composer.phar install
  26
  27 To use the bindings, either user Composer's autoload[https://getcomposer.org/doc/00-intro.md#autoloading]:
  28
  29     require_once('vendor/autoload.php');
  30
  31 Or manually:
  32
  33     require_once('/path/to/vendor/stripe/stripe-php/lib/Stripe.php');
  34
  35 == Manual Installation
  36
  37 Obtain the latest version of the Stripe PHP bindings with:
  38
  39     git clone https://github.com/stripe/stripe-php
  40
  41 To use the bindings, add the following to your PHP script:
  42
  43     require_once("/path/to/stripe-php/lib/Stripe.php");
  44
  45 == Getting Started
  46
  47 Simple usage looks like:
  48
  49     Stripe::setApiKey('d8e8fca2dc0f896fd7cb4cb0031ba249');
  50     $myCard = array('number' => '4242424242424242', 'exp_month' => 5, 'exp_year' => 2015);
  51     $charge = Stripe_Charge::create(array('card' => $myCard, 'amount' => 2000, 'currency' => 'usd'));
  52     echo $charge;
  53
  54 == Documentation
  55
  56 Please see https://stripe.com/api for up-to-date documentation.
  57
  58 == Tests
  59
  60 In order to run tests you have to install SimpleTest[http://packagist.org/packages/simpletest/simpletest] via Composer[http://getcomposer.org/] (recommended way):
  61
  62     composer.phar update --dev
  63
  64 Run test suite:
  65
  66     php ./test/Stripe.php
  67