From 84aa9588dae384db00ccc54856f2989d27e9691e Mon Sep 17 00:00:00 2001 From: Rene Vergara Date: Sun, 1 Jan 2023 15:28:42 -0600 Subject: [PATCH] Updates to README --- README.md | 48 +++++++++--------------------------------------- 1 file changed, 9 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 791c60c..ea3fe88 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ # ZGo Payment Gateway plugin for Woocommerce -ZGo's payment processing solution for WooCommerce. This plugin implements a payment gateway to let buyers pay with Zcash +ZGo's payment processing solution for WooCommerce. This plugin implements a payment gateway that allows WooCommerce sellers to accept Zcash as payment while using their existing shop setup. -## Description - -To Do +Payments are sent directly to the seller's Zcash wallet, using shielded transactions. ## System Requirements @@ -15,43 +13,15 @@ To Do ## Installation -1. Get your ZGo's OwnerID and Token for Woocommerce from your ZGo Shop Account -2. Download the `zgopmtggwy` installation package from Gitlab??? `/wp-content/plugins/` directory. -3. In WooCommerce Settings page go to the Payment Gateways tab, then click on "ZGo Payment", you will be redirected to ZGo Payment Settings page -4. Fill the ZGo OwnerId and ZGo Token fields -5. Click "Save changes" and return to WooCommerce Payments Tab +1. Get your ZGo's OwnerID and Token for WooCommerce from your [ZGo shop settings](https://app.zgo.cash/). +2. Download the latest `zgopmtgwy` installation package from the [Releases](https://git.vergara.tech/Vergara_Tech/ZGoPmtGwy/releases) page, the package signature and verify it. +3. In the WooCommerce Settings page, go to the Plugins tab and click on `Add New`. Click the `Upload Plugin` button and upload the verified ZIP file. You will be redirected to the list of available plugins, now listing the ZGo Payment Gateway. Click on the `Activate` link to enable the plugin. +3. In the WooCommerce Settings page, go to the Payment Gateways tab, then click on "ZGo Payment", you will be redirected to ZGo Payment Settings page. +4. Fill the ZGo OwnerId and ZGo Token fields. +5. Click "Save changes" and return to WooCommerce Payments Tab. 6. Check "Enable" button. The credentials will be verified and the plugin will be activated if they are confirmed. -## Usage - -To Do - ## Support -To Do +- [ZGo User Support Chat](https://matrix.to/#/#zgo-support:vergara.tech) -## Roadmap - - -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment - -To Do - -## License - -License: GPLv2 -License URI: http://www.gnu.org/licenses/gpl-2.0.html - - -## Project status - -Development