diff --git a/README.md b/README.md index 9bfa21a..28a80a1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,25 @@ -# 10grans-NG +# Optimism-Compatible Token -10grans on Base chain, with a bridge to Ethereum. +ERC-20 token with extra features, capable of being bridged to an +Optimism-compatible L2. Built for Base blockchain and the 10Grans token, +specifically but general. ```shell -npx hardhat help -npx hardhat test -REPORT_GAS=true npx hardhat test -npx hardhat node -npx hardhat run scripts/deploy.ts +npx hardhat compile + +cp env.example .env.dev +# (customize your env file here first) + +scripts/deploy-dev.sh + +# optionally verify your contract on L2, customize the following: +NODE_ENV=dev npx hardhat verify --network base-goerli 0xl2tokenaddress MrTestToken TEST 0xbridgeonl2 0xl1tokenaddress ``` + +# Depositing to L2 + +Use this tool: https://git.shipoclu.com/moon/l2-base-bridging + +# License + +MIT license. \ No newline at end of file