Merge pull request #1206 from Shopify/ml-add-get-started-readme

Update READMEs for GraphQL and Storefront API Client to include Getting Started instructions
Shopify · Feb 12, 2024 · 71bda29 · 71bda29
2 parents 2a4b93d + 6e9dae7
commit 71bda29
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 3 deletions.
diff --git a/.changeset/honest-walls-design.md b/.changeset/honest-walls-design.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/graphql-client/README.md b/packages/graphql-client/README.md
@@ -4,11 +4,30 @@ The GraphQL Client can be used to interact with any Shopify's GraphQL APIs. Clie
 
 
 ## Getting Started
+Using your preferred package manager, install this package in a project:
 
-To install this package, you can run this in your terminal:
+```sh
+yarn add @shopify/graphql-client
+```
 
-```typescript
-npm install @shopify/graphql-client
+```sh
+npm install @shopify/graphql-client --s
+```
+
+```sh
+pnpm add @shopify/graphql-client
+```
+
+### CDN
+The UMD builds of each release version are available via the [`unpkg` CDN](https://unpkg.com/browse/@shopify/graphql-client@latest/dist/umd/)
+
+```html
+// The minified `v0.9.3` version of the GraphQL API Client
+<script src="https://unpkg.com/@shopify/[email protected]/dist/umd/graphql-client.min.js"></script>
+
+<script>
+const client = ShopifyGraphQLClient.createGraphQLClient({...});
+</script>
 ```
 
 ## Client initialization

diff --git a/packages/storefront-api-client/README.md b/packages/storefront-api-client/README.md
@@ -2,6 +2,34 @@
 
 The Storefront API Client manages the API's authentication information and provides various methods that enables devs to interacts with the API.
 
+## Getting started
+Using your preferred package manager, install this package in a project:
+
+```sh
+yarn add @shopify/storefront-api-client
+```
+
+```sh
+npm install @shopify/storefront-api-client --s
+```
+
+```sh
+pnpm add @shopify/storefront-api-client
+```
+
+### CDN
+The UMD builds of each release version are available via the [`unpkg` CDN](https://unpkg.com/browse/@shopify/storefront-api-client@latest/dist/umd/)
+
+```html
+// The minified `0.2.3` version of the Storefront API Client
+<script src="https://unpkg.com/@shopify/[email protected]/dist/umd/storefront-api-client.min.js"></script>
+
+
+<script>
+const client = ShopifyStorefrontAPIClient.createStorefrontApiClient({...});
+</script>
+```
+
 ## Initialization
 
 ### Public access token client initialization