Merge pull request #14 from ionux/master

Created GUIDE documentation
bitpay · Feb 20, 2015 · e24b27e · e24b27e
2 parents 7e28307 + 7ba7a27
commit e24b27e
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 28 deletions.
diff --git a/GUIDE.md b/GUIDE.md
@@ -0,0 +1,29 @@
+# Using the BitPay plugin for ZenCart
+
+## Prerequisites
+
+You must have a BitPay merchant account to use this plugin.  It's free to [sign-up for a BitPay merchant account](https://bitpay.com/start).
+
+## Installation
+
+Download the zip file for this plugin, unzip the arcive and copy the files into the ZenCart directory on your webserver.
+
+## Configuration
+
+* Create an API key at bitpay.com under your My Account section.
+* In Admin panel under "Modules > Payment > Bitcoins" click Install.
+* Fill out all configuration information:
+  * Verify that the module is enabled.
+  * Set the API key to the value you created in step 1.
+  * Select a transaction speed.  The high speed will send a confirmation as soon as a transaction is received in the bitcoin network (usually a few seconds).  A medium speed setting will typically take 10 minutes.  The low speed setting usually takes around 1 hour.  See the bitpay.com merchant documentation for a full description of the transaction speed settings: https://bitpay.com/downloads/bitpayApi.pdf<br />
+  * Choose a status for unpaid and paid orders (or leave the default values as defined).<br />
+  * Verify that the currencies displayed correspond to what you want and to those accepted by bitpay.com (the defaults are what bitpay accepts as of this writing).<br />
+  * Choose a sort order for displaying this payment option to visitors.  Lowest is displayed first.<br />
+
+## Usage
+
+When a shopping chooses the Bitcoin payment method, they will be presented with an order summary as the next step (prices are shown in whatever currency they've selected for shopping). Upon receiving their order, the system takes the shopper to a bitpay.com invoice where the user is presented with bitcoin payment instructions.  Once payment is received, a link is presented to the shopper that will take them back to your website.
+
+In your Admin control panel, you can see the orders made with Bitcoins just as you would any other order.  The status you selected in the configuration steps above will indicate whether the order has been paid for.  
+
+**Note:** This extension does not provide a means of automatically pulling a current BTC exchange rate for presenting BTC prices to shoppers.
diff --git a/README.md b/README.md
@@ -1,50 +1,31 @@
-bitpay/zencart-plugin
-=====================
+# Description
 
-# Installation
+This is the BitPay payment plugin for ZenCart.
 
-Copy these files into the ZenCart directory on your webserver.
+## Quick Start Guide
 
-# Configuration
+To get up and running with our plugin quickly, see the GUIDE here: https://github.com/bitpay/zencart-plugin/blob/master/GUIDE.md
 
-1. Create an API key at bitpay.com under your My Account section.
-2. In Admin panel under "Modules > Payment > Bitcoins" click Install.
-3. Fill out all configuration information:<br />
-a. Verify that the module is enabled.<br />
-b. Set the API key to the value you created in step 1.<br />
-c. Select a transaction speed.  The high speed will send a confirmation as soon as a transaction is received in the bitcoin network (usually a few seconds).  A medium speed setting will typically take 10 minutes.  The low speed setting usually takes around 1 hour.  See the bitpay.com merchant documentation for a full description of the transaction speed settings: https://bitpay.com/downloads/bitpayApi.pdf<br />
-d. Choose a status for unpaid and paid orders (or leave the default values as defined).<br />
-e. Verify that the currencies displayed correspond to what you want and to those accepted by bitpay.com (the defaults are what bitpay accepts as of this writing).<br />
-f. Choose a sort order for displaying this payment option to visitors.  Lowest is displayed first.<br />
+## Support
 
-# Usage
-
-When a shopping chooses the Bitcoin payment method, they will be presented with an order summary as the next step (prices are shown in whatever currency they've selected for shopping). Upon receiving their order, the system takes the shopper to a bitpay.com invoice where the user is presented with bitcoin payment instructions.  Once payment is received, a link is presented to the shopper that will take them back to your website.
-
-In your Admin control panel, you can see the orders made with Bitcoins just as you would any other order.  The status you selected in the configuration steps above will indicate whether the order has been paid for.  
-
-**Note:** This extension does not provide a means of automatically pulling a current BTC exchange rate for presenting BTC prices to shoppers.
-
-# Support
-
-## BitPay Support
+### BitPay Support
 
 * [GitHub Issues](https://github.com/bitpay/zencart-plugin/issues)
   * Open an issue if you are having issues with this plugin.
 * [Support](https://support.bitpay.com)
   * BitPay merchant support documentation
 
-## ZenCart Support
+### ZenCart Support
 
 * [Homepage](http://www.zen-cart.com)
 * [Documentation](http://www.zen-cart.com/wiki/index.php/Developers_API)
 * [Support Forums](http://www.zen-cart.com/forum.php)
 
-# Contribute
+## Contribute
 
 To contribute to this project, please fork and submit a pull request.
 
-# License
+## License
 
 The MIT License (MIT)