readmes

base-org · Nov 27, 2023 · 7e601a3 · 7e601a3
1 parent 52e4aea
commit 7e601a3
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
-# OP Wagmi
+<br />
 
-Wagmi hooks for OP Stack Chains
+<h1 align="center">
+  OP Wagmi
+</h1>
+
+<p align="center">
+  Wagmi hooks for OP Stack Chains
+<p>
 
 <!-- Badge row 1 - status -->
 
@@ -29,10 +35,6 @@ Wagmi hooks for OP Stack Chains
 - TypeScript ready
 - Test suite running against [forked](https://ethereum.org/en/glossary/#fork) Ethereum network
 
-## Overview
-
-## Community
-
 ## Contributing
 
 If you're interested in contributing, please read the [contributing docs](CONTRIBUTING.md) **before submitting a pull request**.

diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,22 @@
+<br/>
+
+<h1 align="center">
+  🔴🔵 Superchain Bridge 🔵🔴
+</h1>
+
+This is a basic Superchain Bridge example app, here to showcase OP Wagmi's features. To start the development server, run
+
+```bash
+pnpm dev:example
+```
+
+from the root of the repository.
+
+In this example app, you can:
+
+- Deposit ETH / ERC20s
+- Initiate ETH / ERC20 withdrawals
+- Prove withdrawals
+- Finalize withdrawals
+
+to / from Base Goerli / Optimism Goerli.
diff --git a/example/components/AssetTypeToggle.tsx b/example/components/AssetTypeToggle.tsx
@@ -22,7 +22,7 @@ export function AssetTypeToggle({ selectedAssetType, setSelectedAssetType }: Ass
         }`}
         onClick={() => setSelectedAssetType('erc20')}
       >
-        ERC-20
+        ERC20
       </button>
     </div>
   )
-Original file line number
+Diff line change
@@ Expand Up @@
             }`}
             onClick={() => setSelectedAssetType('erc20')}
           >
-            ERC-20
+            ERC20
           </button>
         </div>
       )
@@ Expand Down @@