Skip to content

Commit

Permalink
Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
germartinez authored Sep 25, 2024
1 parent 8cdd672 commit b675ed6
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,18 @@ This example application shows how to create signers from different service prov

| Provider | Documentation |
| -------- | ------- |
| [Magic](https://magic.link) | [Integrate Magic signer](https://docs.safe.global/sdk/signers/magic) |
| [Dynamic](https://dynamic.xyz) | [Integrate Dynamic signer](https://docs.safe.global/sdk/signers/dynamic) |
| [Magic](https://magic.link) | [Integrate Magic signer](https://docs.safe.global/sdk/signers/magic) |
| [Privy](https://privy.io) | [Integrate Privy signer](https://docs.safe.global/sdk/signers/privy) |
| [Web3Auth](https://web3auth.io) | [Integrate Web3Auth signer](https://docs.safe.global/sdk/signers/web3auth) |

Please read the [Signers section](https://docs.safe.global/sdk/signers) in the Safe documentation to see how to integrate the different providers.

## Prerequisites




This example app shows how to create a web app for using passkeys in your Safe. Please read [How to build an app with Safe and passkeys](https://docs.safe.global/home/passkeys-tutorials/safe-passkeys-tutorial) to see how this app was created.

## What you’ll need

**Prerequisite knowledge:** You will need some basic experience with [React](https://react.dev/learn), [Next.js](https://nextjs.org/docs), and [ERC-4337](https://docs.safe.global/home/4337-overview).

Before progressing with the tutorial, please make sure you have:
You will need some basic experience with [React](https://react.dev/learn), [Next.js](https://nextjs.org/docs). Before progressing with the tutorial, please make sure you have:

- Downloaded and installed [Node.js](https://nodejs.org/en/download/package-manager) and [pnpm](https://pnpm.io/installation).
- Created an API key from [Pimlico](https://www.pimlico.io/).




## Getting Started

Expand All @@ -40,10 +29,13 @@ cd safe-signers
pnpm install
```

This will get a copy of the project installed locally. Now, create a file named `.env.local` at the root of your project, and add your Pimlico API key to it:
This will get a copy of the project installed locally. Now, create an `.env` file at the root of your project, and add the corresponding environment variables:

```bash
echo "NEXT_PUBLIC_PIMLICO_API_KEY='your_pimlico_api_key_goes_here'" > .env.local
```
NEXT_PUBLIC_DYNAMIC_ENVIRONMENT_ID=
NEXT_PUBLIC_MAGIC_API_KEY=
NEXT_PUBLIC_PRIVY_APP_ID=
NEXT_PUBLIC_WEB3AUTH_CLIENT_ID=
```

Run the local development server with the following command:
Expand Down

0 comments on commit b675ed6

Please sign in to comment.