From bbfe3f2c5a6874bb7b0c3769f2cb1c0f1386a35e Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji Date: Tue, 10 Aug 2021 08:42:47 +0100 Subject: [PATCH] docs: add framework README --- framework/commercelayer/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/framework/commercelayer/README.md b/framework/commercelayer/README.md index a3bc1db32..f0544f399 100644 --- a/framework/commercelayer/README.md +++ b/framework/commercelayer/README.md @@ -1 +1,23 @@ -# Next.js Local Provider +# Commerce Layer Provider + +⚠️ This provider is still a work in progress. + +Before getting started, you should do the following: + +- Create a Commerce Layer [developer account](https://commercelayer.io). +- Create a new [organization](https://commercelayer.io/docs/data-model/users-and-organizations/) for your business. +- Create an application with `sales_channel` kind. + +Next, copy the `.env.template` file in this directory to `.env.local` in the main directory (which will be ignored by Git): + +```bash +cp framework/commercelayer/.env.template .env.local +``` + +Next, add the application credentials from your organization application dashboard in `.env.local`. + +## Contribute + +Our commitment to Open Source can be found [here](https://vercel.com/oss). + +If you find an issue with the provider or want a new feature, feel free to open a PR or [create a new issue](https://github.com/vercel/commerce/issues). \ No newline at end of file