diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad2033b --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Nomos Sovereign Rollup Example + +This demo shows a complete Uniswap implementation featuring: + +- [Uniswap's Contracts](./nomos-example-uniswap-contracts/) +- [Nomoswap: Uniswap Frontend](./nomos-example-uniswap/) +- [Blockscout: Block Explorer](./nomos-example-blockscout/) + +## Running + +This is an overview of the steps you'll need to follow to run the full PoC example: + +1. Deploy the [Uniswap's Contracts](./nomos-example-uniswap-contracts/) into an Ethereum Node +2. Deploy [Nomoswap](./nomos-example-uniswap/) +3. _(Optional)_ Deploy [Blockscout](./nomos-example-blockscout/) + +Each component's directory contains a README with important setup instructions - start with the contracts and work your way down the list.