Add documentation on WalletConnect Cloud project (#211)

* Add documentation about WalletConnect Cloud * Add .idea to git ignore * Implement feedback --------- Co-authored-by: Danil Nemirovsky <[email protected]>
hyperlane-xyz · Aug 16, 2024 · 82a4725 · 82a4725
1 parent c9637f9
commit 82a4725
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -37,4 +37,6 @@ yarn-error.log*
 .vercel
 
 # typescript
-*.tsbuildinfo
+*.tsbuildinfo
+
+.idea
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ See [CUSTOMIZE.md](./CUSTOMIZE.md) for details about adjusting the tokens and br
 
 ### Setup
 
+#### Build
 ```sh
 # Install dependencies
 yarn
@@ -26,13 +27,25 @@ yarn
 yarn build
 ```
 
+#### Configure
+
+You need a `projectId` from the WalletConnect Cloud to run the Hyperlane Warp Route UI successfully. 
+Sign up to [WalletConnect Cloud](https://cloud.walletconnect.com/), create 
+new project with AppKit and Next.js and copy the `projectId` from there.
+
 ### Run
 
+You can add `.env.local` file next to `.env.example` where you set `projectId` copied from WalletConnect Cloud.
 ```sh
 # Start the Next dev server
 yarn dev
 ```
 
+Or you can set the WalletConnect Cloud `projectId` to use as follows:
+```
+NEXT_PUBLIC_WALLET_CONNECT_ID=<projectId> yarn dev
+```
+
 ### Test
 
 ```sh