diff --git a/README.md b/README.md index ba741093..9b0cfb01 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ pnpm add get-starknet-core starknet 2. Wrap your app with `StarknetConfig` ```typescript -import { goerli } from "@starknet-react/chains"; +import { sepolia } from "@starknet-react/chains"; import { StarknetConfig, publicProvider, @@ -45,7 +45,7 @@ import { } from "@starknet-react/core"; function App() { - const chains = [goerli]; + const chains = [sepolia]; const provider = publicProvider(); const connectors = [braavos(), argent()]; @@ -53,23 +53,22 @@ function App() { - ) + ); } ``` 3. Access the hooks from your components. ```typescript -import { useAccount } from '@starknet-react/core' +import { useAccount } from "@starknet-react/core"; function YourComponent() { - const { address } = useAccount() + const { address } = useAccount(); - return
gm {address}
+ return
gm {address}
; } ``` ## License This library is licensed under the MIT license. - diff --git a/website/app/layout.tsx b/website/app/layout.tsx index 39e8a3a7..ece46824 100644 --- a/website/app/layout.tsx +++ b/website/app/layout.tsx @@ -9,6 +9,7 @@ import { SiteHeader } from "@/components/site-header"; import { cn } from "@/lib/utils"; import { monoFont, sansFont } from "@/lib/fonts"; import { JotaiProvider } from "@/components/jotai-provider"; +import { Notice } from "@/components/notice"; export const metadata: Metadata = { title: { @@ -29,7 +30,7 @@ export default function RootLayout({ className={cn( "min-h-screen bg-background font-sans antialiased", sansFont.variable, - monoFont.variable, + monoFont.variable )} >
+ +

+ Starknet testnet is migrating to Sepolia.{" "} + + Read more + + . +

+
{children}
diff --git a/website/components/notice.tsx b/website/components/notice.tsx new file mode 100644 index 00000000..bd316391 --- /dev/null +++ b/website/components/notice.tsx @@ -0,0 +1,9 @@ +import React from "react"; + +export function Notice({ children }: { children: React.ReactNode }) { + return ( +
+
{children}
+
+ ); +} diff --git a/website/content/docs/getting-started.mdx b/website/content/docs/getting-started.mdx index 13dea87e..a56bf869 100644 --- a/website/content/docs/getting-started.mdx +++ b/website/content/docs/getting-started.mdx @@ -59,7 +59,7 @@ of recommended connectors with a dynamic list of injected connectors. "use client"; import React from "react"; -import { goerli, mainnet } from "@starknet-react/chains"; +import { sepolia, mainnet } from "@starknet-react/chains"; import { StarknetConfig, publicProvider, @@ -84,7 +84,7 @@ export function StarknetProvider({ children }: { children: React.ReactNode }) { return ( + {children} ); @@ -47,21 +40,23 @@ export default function App({ children }) { ## Options - * __recommended?__`: Connector[]` - - List of recommended connectors. +- **recommended?**`: Connector[]` + + - List of recommended connectors. + +- **includeRecommended?**`: "always" | "onlyIfNoConnectors"` - * __includeRecommended?__`: "always" | "onlyIfNoConnectors"` - - If `"always"`, the hook always returns the recommended connectors. - - If `"onlyIfNoConnectors"`, the recommended connectors are included only if - no other connector is installed. + - If `"always"`, the hook always returns the recommended connectors. + - If `"onlyIfNoConnectors"`, the recommended connectors are included only if + no other connector is installed. - * __order?__`: "random" | "alphabetical"` - - Control the order in which connectors are returned. - - If `"random"`, connectors are shuffled. - - If `"alphabetical"`, connectors are alphabetically sorted by their id. +- **order?**`: "random" | "alphabetical"` + - Control the order in which connectors are returned. + - If `"random"`, connectors are shuffled. + - If `"alphabetical"`, connectors are alphabetically sorted by their id. ## Returns - * __connectors__`: Connector[]` - - Contains the list of injected connectors installed by the user. - - All connectors are unique and sorted. +- **connectors**`: Connector[]` + - Contains the list of injected connectors installed by the user. + - All connectors are unique and sorted.