docs: adjust welcome pages

monerium · Aug 28, 2024 · 98edffb · 98edffb
1 parent d6df010
commit 98edffb
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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';