README.md in spree-bank-transfer-2.2.5 vs README.md in spree-bank-transfer-2.3.0
- old
+ new
@@ -1,23 +1,24 @@
Spree Bank Transfer [![Code Climate](https://codeclimate.com/github/vinsol/spree_bank_transfer.png)](https://codeclimate.com/github/vinsol/spree_bank_transfer) [![Build Status](https://travis-ci.org/vinsol/spree_bank_transfer.png?branch=master)](https://travis-ci.org/vinsol/spree_bank_transfer)
=================
-Spree Bank Transfer extension creates a new payment method in Spree. This payment method allows customers to pay by transferring money directly into merchant’s bank account. It also allows admin to provide their Bank account's (Merchant Bank Account) details which will be displayed to customers while checkout, and they can use this information to make payment for their orders. This extension also facilitate admin to Activate/Deactivate Bank accounts.
+Spree Bank Transfer is an extension which allows adding a new payment method “Bank Transfer” to existing spree e-commerce store. With the help of this payment method customer can place an order online and pay by transferring money directly into merchant’s Bank account. This extension allow merchants to provide their bank account(s) details which in turn is used by customers to order and pay using this method. This extension also facilitate admin to Activate/Deactivate attached Bank accounts. Admin can also filter orders on the basis of the available payment transaction reference numbers with this extension.
+
Installation
------------
Add spree_bank_transfer to your Gemfile:
```ruby
-gem 'spree-bank-transfer'
+gem 'spree-bank-transfer', require: 'spree_bank_transfer'
```
For older versions of Spree.
```ruby
# Spree 2.1.0
-gem 'spree-bank-transfer', '2.1.0'
+gem 'spree-bank-transfer', '2.1.0', require: 'spree_bank_transfer'
```
```ruby
# Spree 2.0.x
gem 'spree-bank-transfer', '2.0.5', require: 'spree_bank_transfer'
@@ -42,29 +43,45 @@
* Add bank account information from “Banks” link on “Configuration” page.
- Provide Name of the bank
- Provide Account number
- Select “Status” check box
+ - Provide “Additional Details”, like “Branch Name”, “Bank code” etc.
- ![Listing Banks](http://vinsol.com/gems_screenshots/spree-bank-transfer/list%20banks.png)
+ ![Listing Banks](http://vinsol.com/gems_screenshots/spree-bank-transfer/listing%20banks.png)
**Bank Account will be visible on Checkout Page only if it is Active.**
* After adding the payment method and bank details (as stated above), this payment method will be visible on Checkout page while making payment against an order.
* Active merchant **accounts number** will also be visible on Checkout page under this method.
- ![Checkout](http://vinsol.com/gems_screenshots/spree-bank-transfer/checkout%20page.png)
+ ![Checkout](http://vinsol.com/gems_screenshots/spree-bank-transfer/checkout.png)
-* Customer will be able to order by completing the order with this method and can transfer money equal to total order value directly into any one of the merchant’s bank account.
+**“How Bank Transfer Works” link will open a pop-up window. It will list all steps to complete order with this method.**
-* After receiving amount into his account, admin can update order by following the steps:
+* Customer will be able to order by completing the order with this method and can transfer money equal to total order
+ value directly into any one of the merchant’s bank account.
- - On ‘Orders’ tab, click on order number to go to the order’s details page..
- - Select “Payments” link.
- - Mark the payment “Capture”
- ![Order Page](http://vinsol.com/gems_screenshots/spree-bank-transfer/order%20page.png)
+* After customer deposits money into merchant’s account, a payment transaction reference number is provided by the bank. Customer needs to add this payment reference details with the respective order by going to order detail page.
+ My Account -> Order no. -> Add details (Payment information column) -> Submit
+
+ ![Order](http://vinsol.com/gems_screenshots/spree-bank-transfer/order.png)
+
+* Admin will be able to see the payment reference details, added by customer, on the Order detail page.
+
+ Orders -> Order no. -> Payments
+
+ ![Payments](http://vinsol.com/gems_screenshots/spree-bank-transfer/payments.png)
+
* The order will not be marked Completed until admin captures the payment as mentioned in step above.
+
+ Note: Admin needs to manually verify the transaction details from his bank account before capturing the payment
+
+* Admin can filter orders which has payment transaction reference number by clicking the check box “only show orders with bank transfer payment reference number” on “Orders” page.
+
+ ![Orders](http://vinsol.com/gems_screenshots/spree-bank-transfer/orders.png)
+
Contributing