Merge cb6620c into d2e5928

README.md

@@ -1,4 +1,42 @@
 SclZfCartPaypoint
 =================
 
-Paypoint payment module for SclZfCart
+Module which allows an application which uses the
+[SclZfCart](https://github.com/SCLInternet/SclZfCart) module to take payments
+via [Paypoint's](http://www.paypoint.net/) hosted gateway.
+
+Installation
+------------
+
+This module requires that you are using both the
+[SclZfCart](https://github.com/SCLInternet/SclZfCart) and
+[SclZfCartPayment](https://github.com/SCLInternet/SclZfCartPayment) modules.
+
+You can easily install this module via composer by adding the following to your
+`composer.json` and running `php composer.phar install`.
+
+```json
+{
+    "require": {
+        "sclinternet/scl-zf-cart": "dev-master",
+        "sclinternet/scl-zf-cart-payment": "dev-master",
+        "sclinternet/scl-zf-cart-paypoint": "dev-master"
+    }
+}
+```
+
+Once the modules are installed add `SclZfCart`, `SclZfCartPayment` and
+`SclZfCartPaypoint` to the modules section of your ZF2 application config.
+
+You will need to refer to both the 
+[SclZfCart](https://github.com/SCLInternet/SclZfCart) and
+[SclZfCartPayment](https://github.com/SCLInternet/SclZfCartPayment) modules for
+their specific instructions setup. Once they are configured copy the
+`data/scl_zf_cart_paypoint.global.php.dist` file to the your application's
+config autoload directory and edit it with your Paypoint account settings.
+
+Finally you will need to  add you will need to add 
+
+`'paypoint' => 'SclZfCartPaypoint\Paypoint',`
+
+to the `payment_methods` section of your `scl_zf_cart_payment` config.

data/scl_zf_cart_paypoint.global.php.dist

@@ -1,17 +1,48 @@
 <?php
 
 return array(
-    'live'            => true,
-    'name'            => 'Paypoint Hosted Page Payment Gateway',
-    'merchant'        => '',
-    'currency'        => 'GBP',
-    'tx_description'  => 'Payment via Paypoint',
-    'live_connection' => array(
-        'url'      => 'https://www.secpay.com/java-bin/ValCard',
-        'password' => '',
-    ),
-    'test_connection' => array(
-        'url'      => 'https://www.secpay.com/java-bin/ValCard',
-        'password' => '',
-    ),
+    /**
+     * Sets whether the system is running in live or test mode.
+     *
+     * Possible values are:
+     * 'live'  - The system is running live and will process real transactions.
+     * 'true'  - The system is in test mode and will return success for test transactions.
+     * 'false' - The system is in test mode and will return failure for test transactions.
+     */
+    'mode'           => 'live',
+
+    /**
+     * The name that will appear when the user is asked to select their payment method.
+     */
+    'name'           => 'Paypoint Hosted Page Payment Gateway',
+
+    /**
+     * The username of the account.
+     */
+    'merchant'       => '',
+
+    /**
+     * The 3 letter currency code for the currency to process the transactions in.
+     */
+    'currency'       => 'GBP',
+
+    /**
+     * The descriptions to appear on the transaction.
+     */
+    'tx_description' => 'Payment via Paypoint',
+
+    /**
+     * The URL of Paypoint's API.
+     */
+    'url'            => 'https://www.secpay.com/java-bin/ValCard',
+
+    /**
+     * The password for the test account.
+     */
+    'test_password'  => '',
+
+    /**
+     * The password for the live account.
+     */
+    'live_password'  => '',
 );