Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README Documentation for Abstract Global Wallet Examples #34

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions agw-connectkit-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet with ConnectKit

This example showcases how to use the Abstract Global Wallet react
This example demonstrates how to use the Abstract Global Wallet react
SDK with [ConnectKit](https://docs.family.co/connectkit) inside a [Next.js](https://nextjs.org/) application.

## Local Development
Expand Down Expand Up @@ -31,4 +31,4 @@ Visit [http://localhost:3000](http://localhost:3000) to see the app.
- [Official Site](https://abs.xyz/)
- [GitHub](https://github.com/Abstract-Foundation)
- [X](https://x.com/AbstractChain)
- [Discord](https://discord.com/invite/abstractchain)
- [Discord](https://discord.com/invite/abstractchain)
2 changes: 1 addition & 1 deletion agw-dynamic-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet with Dynamic

This example showcases how to use the Abstract Global Wallet react
This example demonstrates how to use the Abstract Global Wallet react
SDK with [Dynamic](https://www.dynamic.xyz/) inside a [Next.js](https://nextjs.org/) application.

## Local Development
Expand Down
2 changes: 1 addition & 1 deletion agw-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet with Next.js

This example showcases how to use the Abstract Global Wallet react SDK inside a [Next.js](https://nextjs.org/) application.
This example demonstrates how to use the Abstract Global Wallet react SDK inside a [Next.js](https://nextjs.org/) application.

## Local Development

Expand Down
2 changes: 1 addition & 1 deletion agw-privy-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet with Privy

This example showcases how to use the Abstract Global Wallet react
This example demonstrates how to use the Abstract Global Wallet react
SDK with [Privy](https://privy.io/) inside a [Next.js](https://nextjs.org/) application.

## Local Development
Expand Down
2 changes: 1 addition & 1 deletion agw-rainbowkit-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet with RainbowKit

This example showcases how to use the Abstract Global Wallet react
This example demonstrates how to use the Abstract Global Wallet react
SDK with [RainbowKit](https://www.rainbowkit.com/) inside a [Next.js](https://nextjs.org/) application.

## Local Development
Expand Down
2 changes: 1 addition & 1 deletion agw-thirdweb-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet with Thirdweb

This example showcases how to use the Abstract Global Wallet react
This example demonstrates how to use the Abstract Global Wallet react
SDK with [Thirdweb](https://www.thirdweb.xyz/) inside a [Next.js](https://nextjs.org/) application.

## Local Development
Expand Down
8 changes: 4 additions & 4 deletions session-keys/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Abstract Global Wallet Session Keys

This example showcases how to use [session keys](https://docs.abs.xyz/abstract-global-wallet/agw-client/session-keys/overview) with the Abstract Global Wallet - temporary keys that are approved to execute a pre-defined set of actions without the need for the owner to sign each transaction.
This example demonstrates how to use [session keys](https://docs.abs.xyz/abstract-global-wallet/agw-client/session-keys/overview) with the Abstract Global Wallet - temporary keys that can execute a predefined set of actions without the need for the owner to sign each transaction.

## Local Development

Expand All @@ -10,13 +10,13 @@ This example showcases how to use [session keys](https://docs.abs.xyz/abstract-g
mkdir -p session-keys && curl -L https://codeload.github.com/Abstract-Foundation/examples/tar.gz/main | tar -xz --strip=2 -C session-keys examples-main/session-keys && cd session-keys
```

2. Install dependencies
2. Install the dependencies

```bash
pnpm install
```

3. Run the development server
3. Start the development server

```bash
pnpm dev
Expand All @@ -30,7 +30,7 @@ The example demonstrates three main components:

1. **Wallet Connection**: Users can connect their wallet using the Abstract Global Wallet SDK.

2. **Session Creation**: Once connected, users can create a session key with specific permissions:
2. **Session Creation**: After connecting, users can create a session key with specific permissions:
- Time-limited access (24 hour expiry)
- Limited to specific contract interactions (NFT minting)
- Maximum fee limits for transactions
Expand Down