Skip to content

Commit e973aba

Browse files
committed
Fix: #AR-9518 missing auth-wagmi added
1 parent 3ad1215 commit e973aba

File tree

4 files changed

+70
-7
lines changed

4 files changed

+70
-7
lines changed

docs/auth/auth-core-usage-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
alias: auth-core-usage-guide
3-
title: 'Arcana Auth-Core SDK Usage Guide'
3+
title: 'Arcana Auth Core SDK Usage Guide'
44
description: 'How to install and use the Arcana Auth-Core SDK with sample code and references.'
55
arcana:
66
root_rel_path: ..
@@ -11,7 +11,7 @@ Note, from here the content is a pure markdown file with no mkdocs related tags
1111
of the file in the `auth-core` repo: https://github.com/arcana-network/auth/blob/main/usage.md
1212
-->
1313

14-
# Auth-Core SDK
14+
# {{config.extra.arcana.auth_core_sdk_name}} Usage
1515

1616
{% include "./text-snippets/auth-core-sdk.md" %}
1717

docs/auth/auth-wagmi-usage-guide.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
alias: web-auth-wagmi-usage-guide
3+
title: 'Arcana Auth Wagmi SDK Usage Guide'
4+
description: 'How to install and use the Arcana Auth Wagmi SDK with sample code and references.'
5+
arcana:
6+
root_rel_path: ..
7+
---
8+
9+
<!--
10+
Note, this is a pure markdown file with no mkdocs related tags or keywords. It is a copy
11+
of the file in the `auth` repo: https://github.com/arcana-network/auth/blob/main/usage.md
12+
-->
13+
14+
# {{config.extra.arcana.wagmi_sdk_name}} Usage
15+
16+
Use the {{config.extra.arcana.wagmi_sdk_name}} to onboard users in a Wagmi app via social login. Let users instantly access the in-app {{config.extra.arcana.wallet_name}} and sign blockchain transactions.
17+
18+
<!--
19+
Latest auth-wagmi readme update PR not merged hence commenting https://wagmi-authsdk-ref-guide.netlify.app/ for now
20+
-->
21+
22+
[:octicons-cross-reference-16:{ .icon-color } {% include "./text-snippets/wagmi_authsdkref_url.md" %}](https://deploy-preview-28--wagmi-authsdk-ref-guide.netlify.app/){ .md-button }
23+
24+
## Install
25+
26+
```sh
27+
npm install --save @arcana/auth @arcana/auth-wagmi
28+
```
29+
30+
## Usage
31+
32+
### With plug n play UI
33+
34+
```ts
35+
import { ArcanaConnector } from "@arcana/auth-wagmi"
36+
import { AuthProvider } from "@arcana/auth"
37+
38+
const auth = new AuthProvider(`${arcana_client_id}`)
39+
const connector = ArcanaConnector({
40+
auth,
41+
})
42+
```
43+
44+
### With custom UI
45+
46+
```ts
47+
import { ArcanaConnector } from "@arcana/auth-wagmi"
48+
import { AuthProvider } from "@arcana/auth"
49+
50+
const auth = new AuthProvider(`${arcana_client_id}`)
51+
const connector = ArcanaConnector({
52+
auth,
53+
loginType: {
54+
provider: "google"
55+
}
56+
})
57+
```
58+
59+
For more details on connectors and integrating your app with Wagmi, see [Wagmi documentation](https://wagmi.sh/react/getting-started).
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
<span><a href="https://wagmi-authsdk-ref-guide.netlify.app/" target="_blank">{{config.extra.arcana.wagmi_sdk_name}} Reference Guide</a></span>
1+
<!----
2+
<span><a href="https://wagmi-authsdk-ref-guide.netlify.app/" target="_blank">{{config.extra.arcana.wagmi_sdk_name}} Reference Guide</a></span>
3+
--->
4+
<span><a href="https://deploy-preview-28--wagmi-authsdk-ref-guide.netlify.app/" target="_blank">{{config.extra.arcana.wagmi_sdk_name}} Reference Guide</a></span>

mkdocs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ nav:
539539
- Integrate:
540540
- ca/integrate/wagmi.md
541541
- ca/integrate/web.md
542-
- APIs:
542+
- CA API:
543543
- ca-sdk: ca/ca-usage-guide.md
544544
- ca-wagmi: ca/ca-wagmi-usage-guide.md
545545
- Examples: ca/examples.md
@@ -759,9 +759,10 @@ nav:
759759
- Sign-Up & Login: auth/onboard/passkey-auth/passkey-signup.md
760760
- Login: auth/onboard/passkey-auth/passkey-login.md
761761
- Auth-Core SDK: quick-start/auth-core-quick-start.md
762-
- APIs:
763-
- Auth: auth/auth-usage-guide.md
764-
- Auth-Core: auth/auth-core-usage-guide.md
762+
- Auth API:
763+
- auth: auth/auth-usage-guide.md
764+
- auth-wagmi: auth/auth-wagmi-usage-guide.md
765+
- auth-core: auth/auth-core-usage-guide.md
765766
- Examples:
766767
- Auth-Examples: https://github.com/arcana-network/auth-examples
767768
- Try Auth: https://codesandbox.io/p/github/shaloo/auth-sdk-example-vite-vue/main?import=true

0 commit comments

Comments
 (0)