From 24dd291be2c3786a1397b3e6e6bf9fa269ff680c Mon Sep 17 00:00:00 2001 From: Isiko Saidiali <54436062+SaidiAli@users.noreply.github.com> Date: Sat, 28 Aug 2021 08:11:53 +0300 Subject: [PATCH] Update README.md to include information on how to add a custom provider (#250) * Update README.md * Updated commerce readme Co-authored-by: Luis Alvarez D --- README.md | 2 +- framework/commerce/new-provider.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d53c5ed86..2eeea375b 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ For example: Turning `cart` off will disable Cart capabilities. > NOTE: The selected provider should support the feature that you are toggling. (This means that you can't turn wishlist on if the provider doesn't support this functionality out the box) -- Open `commerce.config.json` +- Open `commerce.config.json` - You'll see a config file like this: ```json { diff --git a/framework/commerce/new-provider.md b/framework/commerce/new-provider.md index 8c2feeab2..6e149a7d4 100644 --- a/framework/commerce/new-provider.md +++ b/framework/commerce/new-provider.md @@ -47,6 +47,12 @@ The app imports from the provider directly instead of the core commerce folder ( The provider folder should only depend on `framework/commerce` and dependencies in the main `package.json`. In the future we'll move the `framework` folder to a package that can be shared easily for multiple apps. +## Updating the list of known providers + +Open [./config.js](./config.js) and add the provider name to the list in `PROVIDERS`. + +Then, open [/.env.template](/.env.template) and add the provider name in the first line. + ## Adding the provider hooks Using BigCommerce as an example. The first thing to do is export a `CommerceProvider` component that includes a `provider` object with all the handlers that can be used for hooks: