From f63e2c67a0e69aabd3f06d9b2ff06406f0949d08 Mon Sep 17 00:00:00 2001
From: cond0r <pinte_catalin@yahoo.com>
Date: Thu, 4 Feb 2021 13:27:58 +0200
Subject: [PATCH] Update README.md

---
 framework/shopify/README.md | 225 +-----------------------------------
 1 file changed, 2 insertions(+), 223 deletions(-)

diff --git a/framework/shopify/README.md b/framework/shopify/README.md
index fc6a70ce3..066a02e52 100644
--- a/framework/shopify/README.md
+++ b/framework/shopify/README.md
@@ -24,237 +24,16 @@ Collection of hooks and data fetching functions to integrate Shopify in a React
 
 ## Getting Started
 
-1. Install dependencies:
+1. Environment variables need to be set:
 
 ```
-yarn install shopify-buy
-yarn install -D @types/shopify-buy
-```
-
-3. Environment variables need to be set:
-
-```
-SHOPIFY_STORE_DOMAIN=
-SHOPIFY_STOREFRONT_ACCESS_TOKEN=
 NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN=
 NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN=
 ```
 
-4. Point the framework to `shopify` by updating `tsconfig.json`:
+2. Point the framework to `shopify` by updating `tsconfig.json`:
 
 ```
 "@framework/*": ["framework/shopify/*"],
 "@framework": ["framework/shopify"]
 ```
-
-### Modifications
-
-These modifications are temporarily until contributions are made to remove them.
-
-#### Adding item to Cart
-
-```js
-// components/product/ProductView/ProductView.tsx
-const ProductView: FC<Props> = ({ product }) => {
-  const addToCart = async () => {
-    setLoading(true)
-    try {
-      await addItem({
-        productId: product.id,
-        variantId: variant ? variant.id : product.variants[0].id,
-      })
-      openSidebar()
-      setLoading(false)
-    } catch (err) {
-      setLoading(false)
-    }
-  }
-}
-```
-
-#### Proceed to Checkout
-
-```js
-// components/cart/CartSidebarView/CartSidebarView.tsx
-import { useCommerce } from '@framework'
-
-const CartSidebarView: FC = () => {
-  const { checkout } = useCommerce()
-  return (
-    <Button href={checkout.webUrl} Component="a" width="100%">
-      Proceed to Checkout
-    </Button>
-  )
-}
-```
-
-## General Usage
-
-### CommerceProvider
-
-Provider component that creates the commerce context for children.
-
-```js
-import { CommerceProvider } from '@framework'
-
-const App = ({ children }) => {
-  return <CommerceProvider locale={locale}>{children}</CommerceProvider>
-}
-
-export default App
-```
-
-### useCommerce
-
-Returns the configs that are defined in the nearest `CommerceProvider`. Also provides access to Shopify's `checkout` and `shop`.
-
-```js
-import { useCommerce } from 'nextjs-commerce-shopify'
-
-const { checkout, shop } = useCommerce()
-```
-
-- `checkout`: The information required to checkout items and pay ([Documentation](https://shopify.dev/docs/storefront-api/reference/checkouts/checkout)).
-- `shop`: Represents a collection of the general settings and information about the shop ([Documentation](https://shopify.dev/docs/storefront-api/reference/online-store/shop/index)).
-
-## Hooks
-
-### usePrice
-
-Display the product variant price according to currency and locale.
-
-```js
-import usePrice from '@framework/product/use-price'
-
-const { price } = usePrice({
-  amount,
-})
-```
-
-Takes in either `amount` or `variant`:
-
-- `amount`: A price value for a particular item if the amount is known.
-- `variant`: A shopify product variant. Price will be extracted from the variant.
-
-### useAddItem
-
-```js
-import { useAddItem } from '@framework/cart'
-
-const AddToCartButton = ({ variantId, quantity }) => {
-  const addItem = useAddItem()
-
-  const addToCart = async () => {
-    await addItem({
-      variantId,
-    })
-  }
-
-  return <button onClick={addToCart}>Add To Cart</button>
-}
-```
-
-### useRemoveItem
-
-```js
-import { useRemoveItem } from '@framework/cart'
-
-const RemoveButton = ({ item }) => {
-  const removeItem = useRemoveItem()
-
-  const handleRemove = async () => {
-    await removeItem({ id: item.id })
-  }
-
-  return <button onClick={handleRemove}>Remove</button>
-}
-```
-
-### useUpdateItem
-
-```js
-import { useUpdateItem } from '@framework/cart'
-
-const CartItem = ({ item }) => {
-  const [quantity, setQuantity] = useState(item.quantity)
-  const updateItem = useUpdateItem(item)
-
-  const updateQuantity = async (e) => {
-    const val = e.target.value
-    await updateItem({ quantity: val })
-  }
-
-  return (
-    <input
-      type="number"
-      max={99}
-      min={0}
-      value={quantity}
-      onChange={updateQuantity}
-    />
-  )
-}
-```
-
-## APIs
-
-Collections of APIs to fetch data from a Shopify store.
-
-The data is fetched using the [Shopify JavaScript Buy SDK](https://github.com/Shopify/js-buy-sdk#readme). Read the [Shopify Storefront API reference](https://shopify.dev/docs/storefront-api/reference) for more information.
-
-### getProduct
-
-Get a single product by its `handle`.
-
-```js
-import getProduct from '@framework/product/get-product'
-import { getConfig } from '@framework/api'
-
-const config = getConfig()
-
-const product = await getProduct({
-  variables: { slug },
-  config,
-})
-```
-
-### getAllProducts
-
-```js
-import getAllProducts from '@framework/product/get-all-products'
-import { getConfig } from '@framework/api'
-
-const config = getConfig()
-
-const { products } = await getAllProducts({
-  variables: { first: 12 },
-  config,
-})
-```
-
-### getAllCollections
-
-```js
-import getAllCollections from '@framework/product/get-all-collections'
-import { getConfig } from '@framework/api'
-
-const config = getConfig()
-
-const collections = await getAllCollections({
-  config,
-})
-```
-
-### getAllPages
-
-```js
-import getAllPages from '@framework/common/get-all-pages'
-import { getConfig } from '@framework/api'
-
-const config = getConfig()
-
-const pages = await getAllPages({
-  variables: { first: 12 },
-  config,
-})
-```