Skip to content

Commit aca25e0

Browse files
committed
Update readme
1 parent eaf9401 commit aca25e0

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

README.md

+14-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Omnipay
22

3-
**An easy to use, consistent payment processing library for PHP 5.3+**
3+
**An easy to use, consistent payment processing library for PHP**
44

55
[![Build Status](https://travis-ci.org/thephpleague/omnipay-common.png?branch=master)](https://travis-ci.org/thephpleague/omnipay-common)
66
[![Latest Stable Version](https://poser.pugx.org/omnipay/omnipay/version)](https://packagist.org/packages/omnipay/omnipay)
@@ -19,18 +19,6 @@ is fully unit tested, and even comes with an example application to get you star
1919
* Because most payment gateways have exceptionally poor documentation
2020
* Because you are writing a shopping cart and need to support multiple gateways
2121

22-
**Important Note: Compatibility with Symfony 3 Event Dispatcher**
23-
24-
If you are using Symfony 3 (or Symfony 3 components), please note that Omnipay 2.x still relies on Guzzle3, which in turn depends on symfony/event-dispatcher 2.x. This conflicts with Symfony 3 (standard install), so cannot be installed. Development for Omnipay 3.x is still in progress at the moment.
25-
26-
If you are just using the Symfony 3 components (eg. stand-alone or Silex/Laravel etc), you could try to force the install of symfony/event-dispatcher:^2.8, which is compatible with both Symfony 3 components and Guzzle 3.
27-
28-
```
29-
composer require symfony/event-dispatcher:^2.8
30-
```
31-
32-
**Please do not submit any more issues or pull requests for updating Omnipay from Guzzle 3 to GuzzleHttp. The update is going to happen in Omnipay version 3.0 which is not yet ready for release.**
33-
3422
## TL;DR
3523

3624
Just want to see some code?
@@ -65,7 +53,8 @@ Omnipay is a collection of packages which all depend on the
6553
[omnipay/common](https://github.com/thephpleague/omnipay-common) package to provide
6654
a consistent interface. There are no dependencies on official payment gateway PHP packages -
6755
we prefer to work with the HTTP API directly. Under the hood, we use the popular and powerful
68-
[Guzzle](http://guzzlephp.org/) library to make HTTP requests.
56+
[PHP-HTTP](http://docs.php-http.org/en/latest/index.html) library to make HTTP requests.
57+
A [Guzzle](http://guzzlephp.org/) adapter is required by default, when using `omnipay/omnipay`.
6958

7059
New gateways can be created by cloning the layout of an existing package. When choosing a
7160
name for your package, please don't use the `omnipay` vendor prefix, as this implies that
@@ -76,20 +65,26 @@ payment library, a good name for your composer package would be `santa/omnipay-g
7665

7766
## Installation
7867

79-
Omnipay is installed via [Composer](https://getcomposer.org/). For most uses, you will need to require an individual gateway:
68+
Omnipay is installed via [Composer](https://getcomposer.org/).
69+
For most uses, you will need to require `omnipay/omnipay` and an individual gateway:
8070

8171
```
82-
composer require omnipay/paypal:~2.0
72+
composer require omnipay/omnipay omnipay/paypal
8373
```
8474

85-
To install all officially supported gateways:
75+
If you want to use your own HTTP Client instead of Guzzle (which is the default for `omnipay/omnipay`),
76+
you can require `omnipay/common` and any `php-http/client-implementation` (see [PHP Http](http://docs.php-http.org/en/latest/clients.html))
8677

8778
```
88-
composer require omnipay/omnipay:~2.0
79+
composer require omnipay/common omnipay/paypal php-http/buzz-adapter
8980
```
9081

91-
> This will require **ALL** ~25 Omnipay gateways and is generally discouraged.
82+
## Upgrade from v2 to v3
83+
84+
If your gateway is supported for v3, you can require that version. Make sure you require `omnipay/omnipay` or a separate Http Adaper.
9285

86+
If there is no version for v3 yet, please raise an issue or upgrade the gateways yourself and create a PR.
87+
See the [Upgrade guide for omnipay/common](https://github.com/thephpleague/omnipay-common/blob/master/UPGRADE.md)
9388

9489
## Payment Gateways
9590

0 commit comments

Comments
 (0)