diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..0750943 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore everything. +/* export-ignore + +# Export white-listed production code only. +/src -export-ignore +/composer.json -export-ignore +/gf-worldpay.php -export-ignore +/LICENSE -export-ignore +/README.md -export-ignore diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9bd0e0d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Itineris Limited + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index d16feb9..bbd9994 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # gf-worldpay +[![Packagist Version](https://img.shields.io/packagist/v/itinerisltd/gf-worldpay.svg)](https://packagist.org/packages/itinerisltd/gf-worldpay) +[![PHP from Packagist](https://img.shields.io/packagist/php-v/itinerisltd/gf-worldpay.svg)](https://packagist.org/packages/itinerisltd/gf-worldpay) +[![Packagist Downloads](https://img.shields.io/packagist/dt/itinerisltd/gf-worldpay.svg)](https://packagist.org/packages/itinerisltd/gf-worldpay) +[![GitHub License](https://img.shields.io/github/license/itinerisltd/gf-worldpay.svg)](https://github.com/ItinerisLtd/gf-worldpay/blob/master/LICENSE) +[![Hire Itineris](https://img.shields.io/badge/Hire-Itineris-ff69b4.svg)](https://www.itineris.co.uk/contact/) + + Gravity forms add-on for WorldPay. @@ -39,20 +46,6 @@ Gravity forms add-on for WorldPay. ## Installation -### Via Composer (Recommended) - -```bash -# composer.json -{ - "repositories": [ - { - "type": "vcs", - "url": "git@github.com:ItinerisLtd/gf-worldpay.git" - } - ] -} -``` - ```bash $ composer require itinerisltd/gf-worldpay ``` @@ -201,11 +194,14 @@ add_filter('gf_worldpay_redirect_url_failure_wp_die', function(bool $shouldWpDie ## Preflight -Checker ID: `gf-worldpay-production-mode` +This plugin provides built-in support for [preflight-command](https://github.com/itinerisltd/preflight-command). +No extra setup steps required. -- ensure all gf-worldpay feeds are in production mode -- this checker can't be disabled -- this checker has no config options + +Checker ID: `gf-worldpay-production-mode` +- ensure all gf-worldpay feeds are in production mode (i.e: not in test mode) +- can't be disabled +- no config options available ## Coding @@ -222,3 +218,23 @@ Read the followings before developing: ### Gravity Forms Gravity Forms has undocumented hidden magics, read its source code. + +## Author Information + +[gf-worldpay](https://github.com/ItinerisLtd/gf-worldpay) is a [Itineris Limited](https://www.itineris.co.uk/) project created by [Tang Rufus](https://typist.tech). + +Full list of contributors can be found [here](https://github.com/ItinerisLtd/gf-worldpay/graphs/contributors). + +## Feedback + +**Please provide feedback!** We want to make this library useful in as many projects as possible. +Please submit an [issue](https://github.com/ItinerisLtd/gf-worldpay/issues/new) and point out what you do and don't like, or fork the project and make suggestions. +**No issue is too small.** + +## Change log + +Please see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently. + +## License + +[gf-worldpay](https://github.com/ItinerisLtd/gf-worldpay) is released under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/composer.json b/composer.json index 7229a18..f659f54 100644 --- a/composer.json +++ b/composer.json @@ -2,9 +2,32 @@ "name": "itinerisltd/gf-worldpay", "type": "wordpress-plugin", "description": "Gravity Forms Add-on for WorldPay", - "license": "proprietary", + "keywords": [ + "gravityforms", + "payment", + "worldpay", + "wordpress", + "wp" + ], + "homepage": "https://github.com/ItinerisLtd/gf-worldpay", + "license": "MIT", + "authors": [ + { + "name": "Itineris Limited", + "email": "hello@itineris.co.uk", + "homepage": "https://itineris.co.uk/", + "role": "Company" + }, + { + "name": "Tang Rufus", + "email": "tangrufus@gmail.com", + "homepage": "https://typist.tech/", + "role": "Developer" + } + ], "require": { "php": "^7.2", + "ext-curl": "*", "league/omnipay": "^3.0", "omnipay/WorldPay": "^3.0" }, @@ -14,9 +37,27 @@ "config": { "sort-packages": true }, + "extra": { + "branch-alias": { + "dev-master": "0.2.x-dev" + } + }, "autoload": { "psr-4": { "Itineris\\WorldPay\\": "src/" } + }, + "scripts": { + "pretag": [ + "composer update", + "composer normalize", + "doctoc README.md", + "github_changelog_generator --no-verbose" + ] + }, + "support": { + "email": "hello@itineris.co.uk", + "issues": "https://github.com/ItinerisLtd/gf-worldpay/issues", + "source": "https://github.com/ItinerisLtd/gf-worldpay" } }