Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
d11wtq committed Jul 25, 2012
1 parent ccb37b3 commit fe3a13d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,7 @@
# A Ruby API for PayPal Adaptive Payments

- Current Status: Work-in-progress (don't use, API subject to major change)
- Working:
- setting up an explicit preapproval
- processing payments (for an explicit preapproval)
- Not working:
- executing pre-created payments
- changing options on a created payment
- refunds/cancellations
- minor things like currency conversion requests

This gem provides access to PayPal's Adaptive Payments API using easy-to-use
ruby classes. The internals are largely backed by
ruby classes. The internals are largely backed by
[Virtus](https://github.com/solnic/virtus) and
[RestClient](https://github.com/archiloque/rest-client), and so are easy to
work with.
Expand All @@ -22,6 +12,16 @@ Via rubygems:

gem install pp-adaptive

All API calls are made by calling `#execute` on the client, with the relevant
request object. Naming conventions have been ruby-ized, but you should just
follow along with the PayPal documentation to understand the inputs and outputs.

Some aliases have been added, to make things simpler. This documentation is a
work in progress, so it's probably better to browse the source files, which are
effectively models that are declarative in nature.

Some quick examples follow.

## Setting up a Preapproval Agreement

``` ruby
Expand Down

0 comments on commit fe3a13d

Please sign in to comment.