Skip to content

Commit 93c9c1d

Browse files
authored
Update README.md
1 parent 1a0009d commit 93c9c1d

File tree

1 file changed

+20
-31
lines changed

1 file changed

+20
-31
lines changed

README.md

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,46 @@
1-
# Paystack Gateway for WHMCS
21

3-
A plugin that allows WHMCS users accept payments using Paystack
2+
# Paystack WHMCS Plugin
43

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
611

712
- Existing WHMCS installation on your web server.
813
- Supported Web Servers: Apache and Nginx
914
- PHP (5.5.19 or more recent) and extensions, MySQL and web browser
1015
- cURL (7.34.0 or more recent)
1116
- OpenSSL v1.0.1 or more recent
1217

13-
## Prepare
18+
### Prepare
1419

1520
- Before you can start taking payments through Paystack, you will first need to sign up at:
1621
[https://dashboard.paystack.co/#/signup][link-signup]. To receive live payments, you should request a Go-live after
1722
you are done with configuration and have successfully made a test payment.
1823

19-
## Install
24+
### Install
2025
1. Copy [paystack.php](modules/gateways/paystack.php?raw=true) in [modules/gateways](modules/gateways) to the `/modules/gateways/` folder of your WHMCS installation.
2126

2227
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.
2328

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
3730

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)
3933

40-
## Security
34+
## Support
4135

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).
4337

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).
4539

46-
- [Ibrahim Lawal][link-author2]
47-
- [All Contributors][link-contributors]
40+
## Community
4841

49-
## License
42+
If you are a developer, please join our Developer Community on [Slack](https://slack.paystack.com).
5043

51-
The MIT License (MIT). Please see [License File](LICENSE) for more information.
44+
## Contributing to the WHMCS plugin
5245

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

Comments
 (0)