diff --git a/README.md b/README.md index 30fec52..2dd3b5c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ -# OP Wagmi +
-Wagmi hooks for OP Stack Chains +

+ OP Wagmi +

+ +

+ Wagmi hooks for OP Stack Chains +

@@ -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 index e69de29..92b92c8 100644 --- a/example/README.md +++ b/example/README.md @@ -0,0 +1,22 @@ +
+ +

+ 🔴🔵 Superchain Bridge 🔵🔴 +

+ +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 index 6f10469..2db0252 100644 --- 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 )