From b675ed6ab7db8add8ce5ece98068d03c90e51a48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Germ=C3=A1n=20Mart=C3=ADnez?= <6764315+germartinez@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:36:14 +0100 Subject: [PATCH] Update README file --- README.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a0b5416..221d8c7 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: