From 98edffb2475d1667fb2d834b38491f31afcd2126 Mon Sep 17 00:00:00 2001 From: einaralex Date: Wed, 28 Aug 2024 16:02:45 +0000 Subject: [PATCH] docs: adjust welcome pages --- apps/developer/docs/index.md | 6 +++++- apps/developer/docs/packages/sdk-react-provider/index.md | 4 +++- packages/sdk-react-provider/src/index.ts | 4 +++- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/apps/developer/docs/index.md b/apps/developer/docs/index.md index f82f58ec..72fa5ffd 100644 --- a/apps/developer/docs/index.md +++ b/apps/developer/docs/index.md @@ -1 +1,5 @@ -# Welcome +# Packages + +## [@monerium/sdk](packages/sdk/index.md) + +## [@monerium/sdk-react-provider](packages/sdk-react-provider/index.md) diff --git a/apps/developer/docs/packages/sdk-react-provider/index.md b/apps/developer/docs/packages/sdk-react-provider/index.md index 1cc610f1..7c395dc3 100644 --- a/apps/developer/docs/packages/sdk-react-provider/index.md +++ b/apps/developer/docs/packages/sdk-react-provider/index.md @@ -2,7 +2,7 @@ A library to interact with Monerium API with React hooks. -This context provider utilizes React Query for async data fetching and caching. +The MoneriumProvider context provider utilizes React Query for async data fetching and caching. ## Installation @@ -16,6 +16,8 @@ Wrap your app in the `QueryClientProvider` React Context Provider and pass a ne Inside the `QueryClientProvider`, wrap your app in the `MoneriumProvider` React Context Provider and pass the auth flow's `clientId`, `redirectUri`, and `environment` configuration. +Hooks are now accessible in your app. + ## Example ```tsx diff --git a/packages/sdk-react-provider/src/index.ts b/packages/sdk-react-provider/src/index.ts index 65505182..4c79704f 100644 --- a/packages/sdk-react-provider/src/index.ts +++ b/packages/sdk-react-provider/src/index.ts @@ -2,7 +2,7 @@ * @packageDocumentation * A library to interact with Monerium API with React hooks. * - * This context provider utilizes React Query for async data fetching and caching. + * The MoneriumProvider context provider utilizes React Query for async data fetching and caching. * * ## Installation * @@ -16,6 +16,8 @@ * * Inside the `QueryClientProvider`, wrap your app in the `MoneriumProvider` React Context Provider and pass the auth flow's `clientId`, `redirectUri`, and `environment` configuration. * + * Hooks are now accessible in your app. + * * @example * ```tsx * import { createRoot } from 'react-dom/client';