Skip to content

Commit 7fe0900

Browse files
author
Akos Csernak
committed
Updates READMEs
1 parent 48e8c9e commit 7fe0900

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ If your app needs to interact with XM Cloud APIs, you also need to install the `
2121
npm install @sitecore-marketplace-sdk/xmc
2222
```
2323

24+
> [!NOTE]
25+
> For Intellisense to work correctly with the SDK packages, make sure all peer dependencies are installed and their versions are compatible. Issues with peer dependencies are logged in your terminal.
26+
2427
Then, refer to the READMEs of the installed packages and the reference documentation in the `/docs` folder.
2528

2629

packages/client/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
The `client` package provides secure, bidirectional communication between a Marketplace application (the client) and Sitecore (the host). Sitecore loads the Marketplace app inside a sandboxed [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe). The iframe and its parent window securely communicate using the web browser's [PostMessage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage).
44

5-
This package lets you make queries and perform mutations:
6-
- Queries support one-off data requests and subscriptions for live updates.
7-
- Mutations trigger state changes or HTTP requests in Sitecore.
5+
This package lets you:
6+
- Make queries. Queries support one-off data requests and subscriptions for live updates. The `client` package lets you query the host's state and environment, and the [context](#query-the-application-context) of your Marketplace app.
7+
- Perform mutations. Mutations trigger state changes or HTTP requests in Sitecore.
8+
- Interact with Sitecore APIs to perform actions on behalf of the resources it was granted access to during installation.
89
> [!TIP]
910
> Inspired by GraphQL and React Query, the query/mutation API manages internal state, loading status, and error handling.
1011

0 commit comments

Comments
 (0)