Browse Source

Fix up README markup [ci skip]

1-2-stable-sysmocom
Trung Lê 9 years ago
parent
commit
d359eff0d1
  1. 74
      README.md

74
README.markdown → README.md

@ -12,9 +12,9 @@ This extension allows the store to use PayPal Express from two locations:
options on the payment stage of the standard checkout. The selected shipping address and shipping method / costs are automatically
sent to the PayPal review page (along with detailed order information).
2. Cart Checkout* - Presents the PayPal checkout button on the users Cart page and redirects the user to complete
all shipping / addressing information on PaypPal's site. This also supports PayPal's Instant Update feature to retrieve shipping options live from
all shipping / addressing information on PaypPal's site. This also supports PayPal's Instant Update feature to retrieve shipping options live from
Spree when the user selects / changes their shipping address on PayPal's site.
* Check "Checkout from cart" in admin for feature to work
@ -28,17 +28,15 @@ Installation
1. Add the following line to your application's Gemfile
gem "spree_paypal_express", :git => "git://github.com/spree/spree_paypal_express.git"
**Note:** The :git option is only required for the edge version, and can be removed to used the released gem.
gem "spree_paypal_express", :git => "git://github.com/spree/spree_paypal_express.git"
2. Install the gem using Bundler:
bundle install
bundle install
3. Copy & run migrations
bundle exec rails g spree_paypal_express:install
bundle exec rails g spree_paypal_express:install
Versions
========
@ -53,12 +51,12 @@ eCheck payments are now fully supported and PayPal's Instant Payment Notificatio
2. Set the IPN URL on your PayPal account (under Profile on PayPal's website) to:
https://www.yourstore.com/paypal_notify
https://www.yourstore.com/paypal_notify
3. Enable auto_capture within Spree (as eCheck payments are only supported for purchase and not authorize requests).
Spree::Config.set(:auto_capture => true)
Spree::Config.set(:auto_capture => true)
**Please note if you accept foreign currency:**
Auto Capture will only work if you configure your Paypal Store like so:
@ -77,39 +75,39 @@ Configuration
=============
1. Before you begin
You'll need to have a Paypal developer account (developer.paypal.com) and both buyer and seller test accounts.
**Tip:** these are sandbox only, so use email addresses and passwords that are easy to remember, e.g. buyer@example.com and seller@example.com.
Your sandbox credentials are available from the API Credentials link.
2. Setup the Payment Method
Log in as an admin and add a new **Payment Method** (under Configuration), using following details:
**Name:** Paypal Express
**Environment:** Development (or what ever environment you prefer)
**Active:** Yes
**Provider:** Spree::BillingIntegration::PaypalExpress
Click **Create* , and now add your credentials in the screen that follows:
**Review:** unchecked [1]
**Signature:** API signature from your paypal seller test account
**Server:** test (for Development or live for Production)
**Test Mode:** checked (or unchecked for Production)
**Password:** API Password from your paypal seller test account
**Login:** API Username from your paypal seller test account (care to use the API Username and not the Test Account address)
Click **Update**
Test Drive
@ -118,21 +116,21 @@ Test Drive
While testing PayPal Express checkout locally make sure you're logged into your PayPal **developer** account in another browser window before attempting a PayPal payment, as you'll be redirected and forced to sign in to your developer account.
1. Add an item to cart
2. Check out
3. Address step: complete it using a valid US address.
4. Delivery step: pick anything
5. On the Payment Step, you should see a PayPal button. You can select it directly or just click "Continue"
6. You will get redirected to PayPals sandbox site, be sure to log in as a **Buyer** / **Personal** test account and not the account you use to configure the Payment Method with.
6. You will get redirected to PayPals sandbox site, be sure to log in as a **Buyer** / **Personal** test account and not the account you use to configure the Payment Method with.
7. You should now see the paypal order details screen with a Pay Now button.
8. Click Pay Now, and you should now be redirected back to Spree's order thank you page.
9. Log into the Admin UI and review the Order and Payment details to confirm the successful checkout.
@ -141,19 +139,19 @@ Running Specs
1. Create Test App
rake test_app
rake test_app
2. Run Specs
rake spec
rake spec
NOTES
=====
To automatically capture funds or enable accepting eCheck payments, add this to you site extension's activate method:
if Spree::Config.instance
Spree::Config[:auto_capture] = true
end
[1] If you check the review checkbox in the admin section for Payment Methods/Paypal Express, the flow is slightly different. Instead of Pay Now on Paypal's order details page, it now says Continue. And the user is directed back to the spree app's Confirmation page showing a place order button. Use whichever suits your needs best. Personally, I leave review unchecked to cut down on the steps in the checkout flow.
Loading…
Cancel
Save