Skip to content

Commit a91e7ff

Browse files
committed
Update readme for 2.0
1 parent d9854df commit a91e7ff

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

README.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

5-
[![Build Status](https://travis-ci.org/omnipay/omnipay.png?branch=master)](https://travis-ci.org/omnipay/omnipay)
5+
[![Build Status](https://travis-ci.org/omnipay/common.png?branch=master)](https://travis-ci.org/omnipay/common)
66
[![Latest Stable Version](https://poser.pugx.org/omnipay/omnipay/version.png)](https://packagist.org/packages/omnipay/omnipay)
77
[![Total Downloads](https://poser.pugx.org/omnipay/omnipay/d/total.png)](https://packagist.org/packages/omnipay/omnipay)
88

@@ -19,19 +19,22 @@ 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: Upgrading from <1.0**
22+
**Important Note: Upgrading from <2.0**
2323

24-
If you are upgrading from a pre-1.0 version of Omnipay, please note that the currency format has changed.
25-
See the [changelog](https://github.com/omnipay/omnipay/blob/master/CHANGELOG.md) for more details.
24+
If you are upgrading from a pre-2.0 version of Omnipay, please note that the
25+
project has now been split into multiple packages. There have also been some
26+
changes to how gateway instances are created. See the
27+
[full release notes](https://github.com/omnipay/omnipay/releases/tag/v2.0.0)
28+
for more details.
2629

2730
## TL;DR
2831

2932
Just want to see some code?
3033

3134
```php
32-
use Omnipay\Common\GatewayFactory;
35+
use Omnipay\Omnipay;
3336

34-
$gateway = GatewayFactory::create('Stripe');
37+
$gateway = Omnipay::create('Stripe');
3538
$gateway->setApiKey('abc123');
3639

3740
$formData = ['number' => '4242424242424242', 'expiryMonth' => '6', 'expiryYear' => '2016', 'cvv' => '123'];
@@ -121,9 +124,9 @@ The following gateways are already implemented:
121124
Gateways are created and initialized like so:
122125

123126
```php
124-
use Omnipay\Common\GatewayFactory;
127+
use Omnipay\Omnipay;
125128

126-
$gateway = GatewayFactory::create('PayPal_Express');
129+
$gateway = Omnipay::create('PayPal_Express');
127130
$gateway->setUsername('adrian');
128131
$gateway->setPassword('12345');
129132
```
@@ -396,24 +399,11 @@ If you want to keep up to date with release anouncements, discuss ideas for the
396399
or ask more detailed questions, there is also a [mailing list](https://groups.google.com/forum/#!forum/omnipay) which
397400
you can subscribe to.
398401

399-
If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/omnipay/omnipay/issues),
400-
or better yet, fork the library and submit a pull request.
401-
402-
## Contributing
403-
404-
* Fork the project.
405-
* Make your feature addition or bug fix.
406-
* Add tests for it. This is important so I don't break it in a future version unintentionally.
407-
* Commit just the modifications, do not mess with the composer.json or CHANGELOG.md files.
408-
* Ensure your code is nicely formatted in the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
409-
style and that all tests pass.
410-
* Send the pull request.
411-
* Check that the [travis build](https://travis-ci.org/omnipay/omnipay) passed. If not, rinse and repeat.
402+
If you believe you have found a bug, please report it using the GitHub issue tracker
403+
for the appropriate package, or better yet, fork the library and submit a pull request.
412404

413405
## Feedback
414406

415407
**Please provide feedback!** We want to make this library useful in as many projects as possible.
416408
Please head on over to the [mailing list](https://groups.google.com/forum/#!forum/omnipay)
417409
and point out what you do and don't like, or fork the project and make suggestions. **No issue is too small.**
418-
419-
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/adrianmacneil/omnipay/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

0 commit comments

Comments
 (0)