docs(auth): ensure auth dapp/wallet readmes are relevant (#63)

* docs(auth): update wallet readme * docs(auth): update dapp readme
2022-09-15 19:50:52 +02:00
parent 207c6871ba
commit 8146e37fc6
2 changed files with 41 additions and 21 deletions
@@ -1,9 +1,39 @@
-# Auth Client JS demo
+# React Auth dApp (React, Typescript, Next.js, Ethers)

-This is a demo for the auth client
+🔗 Live dapp demo - https://react-auth-dapp.walletconnect.com/ <br />
+🔗 Live wallet demo - https://react-auth-wallet.walletconnect.com/ <br />
+📚 WalletConnect v2 Docs - https://docs.walletconnect.com/2.0

-# Commands
+## Overview

-`npm run dev` for development mode
-`npm run build` for building the application
+This example aims to demonstrate dapp-facing use cases enabled by WalletConnect Auth Alpha.

+## Running locally
+
+Install the app's dependencies:
+
+```bash
+npm i
+```
+
+Set up your local environment variables by copying the example into your own `.env.local` file:
+
+```bash
+cp .env.local.example .env.local
+```
+
+Your `.env.local` now contains the following environment variables:
+
+- `NEXT_PUBLIC_PROJECT_ID` (placeholder) - You can generate your own ProjectId at https://cloud.walletconnect.com
+
+## Develop
+
+```bash
+npm run dev
+```
+
+## Build
+
+```bash
+npm run build
+```