Update README.md

README.md

@@ -1,7 +1,133 @@
 # omnipay-advcash
-Nixmoney gateway for [Omnipay](https://github.com/thephpleague/omnipay) payment processing library.
+[![Build Status](https://travis-ci.org/aleksandrzhiliaev/omnipay-advcash.svg?branch=master)](https://travis-ci.org/aleksandrzhiliaev/omnipay-advcash)
 
-## To-do
-- Full documentation
-- Handling all custom parameters
-- Unit tests
+Advcash gateway for [Omnipay](https://github.com/thephpleague/omnipay) payment processing library.
+
+[Omnipay](https://github.com/omnipay/omnipay) is a framework agnostic, multi-gateway payment
+processing library for PHP 5.3+. This package implements Advcash support for Omnipay.
+
+## Installation
+
+Omnipay is installed via [Composer](http://getcomposer.org/). To install, simply add it
+to your `composer.json` file:
+
+```json
+{
+    "require": {
+        "aleksandrzhiliaev/omnipay-advcash": "*"
+    }
+}
+```
+
+And run composer to update your dependencies:
+
+    $ curl -s http://getcomposer.org/installer | php
+    $ php composer.phar update
+
+## Basic Usage
+
+The following gateways are provided by this package:
+
+* Advcash
+
+For general usage instructions, please see the main [Omnipay](https://github.com/omnipay/omnipay)
+repository. See also the [Nixmoney Documentation](http://info.nixmoney.com/en/integration)
+
+## Example
+1. Purchase:
+```php
+$gateway = Omnipay::create('Advcash');
+
+$gateway->setAccount('');
+$gateway->setAccountName('');
+$gateway->setSecret('');
+$gateway->setApiName('');
+$gateway->setApiSecret('');
+$gateway->setCurrency('USD');
+
+
+$response = $gateway->purchase([
+       'amount' => '0.1',
+       'currency' => 'USD',
+       'transactionId' => time(),
+       'description' => 'Order # 123',
+       'cancelUrl' => 'https://example.com',
+       'returnUrl' => 'https://example.com',
+       'notifyUrl' => 'https://example.com'
+        ])->send();
+
+if ($response->isSuccessful()) {
+   // success
+} elseif ($response->isRedirect()) {
+
+   # Generate form to do payment
+   $hiddenFields = '';
+   foreach ($response->getRedirectData() as $key => $value) {
+       $hiddenFields .= sprintf(
+          '<input type="hidden" name="%1$s" value="%2$s" />',
+           htmlentities($key, ENT_QUOTES, 'UTF-8', false),
+           htmlentities($value, ENT_QUOTES, 'UTF-8', false)
+          )."\n";
+   }
+
+   $output = '<form action="%1$s" method="post"> %2$s <input type="submit" value="Purchase" /></form>';
+   $output = sprintf(
+      $output,
+      htmlentities($response->getRedirectUrl(), ENT_QUOTES, 'UTF-8', false),
+      $hiddenFields
+   );
+   echo $output;
+   # End of generating form
+} else {
+   echo $response->getMessage();
+}
+```
+2. Validate webhook
+```php
+try {
+    $response = $gateway->completePurchase()->send();
+    $transactionId = $response->getTransactionId();
+    $amount = $response->getAmount();
+    $success = $response->isSuccessful();
+    $currency = $response->getCurrency();
+    if ($success) {
+       // success 
+    }
+} catch (\Exception $e) {
+  // check $e->getMessage()
+}
+```
+3. Do refund
+```php
+try {
+    $response = $gateway->refund(
+        [
+            'payeeAccount' => '',
+            'amount' => 0.1,
+            'description' => 'Testing advcash',
+            'currency' => 'USD',
+        ]
+    )->send();
+
+    if ($response->isSuccessful()) {
+        // success  
+    } else {
+        // check $response->getMessage();
+    }
+
+} catch (\Exception $e) {
+    // check $e->getMessage();
+}
+```
+
+## Support
+
+If you are having general issues with Omnipay, we suggest posting on
+[Stack Overflow](http://stackoverflow.com/). Be sure to add the
+[omnipay tag](http://stackoverflow.com/questions/tagged/omnipay) so it can be easily found.
+
+If you want to keep up to date with release anouncements, discuss ideas for the project,
+or ask more detailed questions, there is also a [mailing list](https://groups.google.com/forum/#!forum/omnipay) which
+you can subscribe to.
+
+If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/aleksandrzhiliaev/omnipay-nixmoney/issues).