|
1 | | -# Paystack Gateway for WHMCS |
2 | 1 |
|
3 | | -A plugin that allows WHMCS users accept payments using Paystack |
| 2 | +# Paystack WHMCS Plugin |
4 | 3 |
|
5 | | -## Requirements |
| 4 | +Welcome to the Paystack WHMCS plugin repository on GitHub. |
| 5 | + |
| 6 | +Here you can browse the source code, look at open issues and keep track of development. |
| 7 | + |
| 8 | +## Installation |
| 9 | + |
| 10 | +### Requirements |
6 | 11 |
|
7 | 12 | - Existing WHMCS installation on your web server. |
8 | 13 | - Supported Web Servers: Apache and Nginx |
9 | 14 | - PHP (5.5.19 or more recent) and extensions, MySQL and web browser |
10 | 15 | - cURL (7.34.0 or more recent) |
11 | 16 | - OpenSSL v1.0.1 or more recent |
12 | 17 |
|
13 | | -## Prepare |
| 18 | +### Prepare |
14 | 19 |
|
15 | 20 | - Before you can start taking payments through Paystack, you will first need to sign up at: |
16 | 21 | [https://dashboard.paystack.co/#/signup][link-signup]. To receive live payments, you should request a Go-live after |
17 | 22 | you are done with configuration and have successfully made a test payment. |
18 | 23 |
|
19 | | -## Install |
| 24 | +### Install |
20 | 25 | 1. Copy [paystack.php](modules/gateways/paystack.php?raw=true) in [modules/gateways](modules/gateways) to the `/modules/gateways/` folder of your WHMCS installation. |
21 | 26 |
|
22 | 27 | 2. Copy [paystack.php](modules/gateways/callback/paystack.php?raw=true) in [modules/gateways/callback](modules/gateways/callback) to the `/modules/gateways/callback` folder of your WHMCS installation. |
23 | 28 |
|
24 | | -## I'm ready! |
25 | | - |
26 | | -- Request `Go-live` on the Paystack Dashboard. |
27 | | - |
28 | | -## Note |
29 | | - |
30 | | -- Paystack currently only accepts `NGN` for now. |
31 | | - |
32 | | -## Change log |
33 | | - |
34 | | -Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. |
35 | | - |
36 | | -## Contributing |
| 29 | +## Documentation |
37 | 30 |
|
38 | | -Please see [CONTRIBUTING](CONTRIBUTING.md) for details. |
| 31 | +* [Paystack Documentation](https://developers.paystack.co/v2.0/docs/) |
| 32 | +* [Paystack Helpdesk](https://paystack.com/help) |
39 | 33 |
|
40 | | -## Security |
| 34 | +## Support |
41 | 35 |
|
42 | | -If you discover any security related issues, please email `support@paystack.com` instead of using the issue tracker. |
| 36 | +For bug reports and feature requests directly related to this plugin, please use the [issue tracker](https://github.com/PaystackHQ/plugin-whmcs/issues). |
43 | 37 |
|
44 | | -## Credits |
| 38 | +For general support or questions about your Paystack account, you can reach out by sending a message from [our website](https://paystack.com/contact). |
45 | 39 |
|
46 | | -- [Ibrahim Lawal][link-author2] |
47 | | -- [All Contributors][link-contributors] |
| 40 | +## Community |
48 | 41 |
|
49 | | -## License |
| 42 | +If you are a developer, please join our Developer Community on [Slack](https://slack.paystack.com). |
50 | 43 |
|
51 | | -The MIT License (MIT). Please see [License File](LICENSE) for more information. |
| 44 | +## Contributing to the WHMCS plugin |
52 | 45 |
|
53 | | -[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square |
54 | | -[link-author]: https://github.com/paystackhq |
55 | | -[link-signup]: https://dashboard.paystack.co/#/signup |
56 | | -[link-author2]: https://github.com/ibrahimlawal |
57 | | -[link-contributors]: ../../contributors |
| 46 | +If you have a patch or have stumbled upon an issue with the WHMCS plugin, you can contribute this back to the code. Please read our [contributor guidelines](https://github.com/PaystackHQ/plugin-whmcs/blob/master/CONTRIBUTING.md) for more information how you can do this. |
0 commit comments