Permalink
Browse files

Update documentation and gemspec (0.0.1.alpha1)

  • Loading branch information...
1 parent 28b8880 commit 53aa666bf6dac9c3364f48a042bff8870d07f70f @samleb samleb committed Feb 11, 2013
Showing with 42 additions and 8 deletions.
  1. +40 −6 README.md
  2. +2 −2 activemerchant-payline.gemspec
View
46 README.md
@@ -1,6 +1,41 @@
-# ActiveMerchant Payline (DirectPaymentAPI)
+# ActiveMerchant Payline
-TODO: Write a gem description
+ActiveMerchant implementation of the [Payline] [1] Gateway.
+
+## Introduction
+
+### Disclaimer
+
+This project is a work in progress and is still in alpha stage.
+All method names and arguments are subject to changes.
+
+**DO NOT USE IT IN PRODUCTION** unless you fully understand the implications.
+
+### Current support
+
+#### Direct Payment API
+
+* doAuthorization (`authorize`)
+* doCapture (`capture`)
+* doRecurrentWalletPayment
+* getPaymentRecord
+* disablePaymentRecord
+
+#### Web Payment API
+
+* doWebPayment (`setup_purchase`)
+* createWebWallet
+* getWebWallet
+* updateWebWallet
+
+### TODO
+
+A beta release will be considered when this list is complete:
+
+* Add support for missing Direct Payment API methods
+* Add support for missing Web Payment API methods
+* Implement unit tests
+* Implement remote tests using [Payline Homologation] [2]
## Installation
@@ -16,14 +51,13 @@ Or install it yourself as:
$ gem install activemerchant-payline
-## Usage
-
-TODO: Write usage instructions here
-
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+[1]: http://www.payline.com/
+[2]: https://homologation-admin.payline.com/
View
4 activemerchant-payline.gemspec
@@ -4,10 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
Gem::Specification.new do |gem|
gem.name = "activemerchant-payline"
- gem.version = "0.0.1"
+ gem.version = "0.0.1.alpha1"
gem.authors = ["Samuel Lebeau"]
gem.email = ["samuel.lebeau@gmail.com"]
- gem.summary = %q{ActiveMerchant Gateway for Payline DirectPayment API}
+ gem.summary = %q{Partial ActiveMerchant implementation of the Payline Gateway.}
gem.homepage = "https://github.com/Goldmund/activemerchant-payline"
gem.files = `git ls-files`.split($/)

0 comments on commit 53aa666

Please sign in to comment.