diff --git a/README.md b/README.md index 5ff7a34..b91ca0b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ -# revenue-sharing-contract -This is a modified version of the Turnstile contract from Canto -```https://github.com/Canto-Improvement-Proposals/CIPs/blob/main/CIP-001.md``` +# Revenue Sharing Contract +This is a modified version of the Turnstile contract from Canto: + +[https://github.com/Canto-Improvement-Proposals/CIPs/blob/main/CIP-001.md](https://github.com/Canto-Improvement-Proposals/CIPs/blob/main/CIP-001.md) + ## Setup -`forge install` +```bash +forge install +``` ## Deploy Create `.env` file and set Ethereum RPC at `MODE_RPC_URL` and deployer private key at `PRIVATE_KEY`. Run -``` +```bash source .env forge script script/FeeSharing.s.sol:FeeSharingScript --rpc-url $MODE_RPC_URL --broadcast -vvvv ``` ## Test -`forge test -vvv` +```bash +forge test -vvv +```