diff --git a/README.md b/README.md index dc7b0f048..3dbae51c2 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ Bitcoin Liquid Staking -[![Solidity](https://github.com/thesis/acre/actions/workflows/solidity.yaml/badge.svg?branch=main&event=push)](https://github.com/thesis/acre/actions/workflows/solidity.yaml) - ## Development ### pnpm diff --git a/solidity/README.md b/solidity/README.md index b90952ee8..651236aa9 100644 --- a/solidity/README.md +++ b/solidity/README.md @@ -1,3 +1,48 @@ -# Acre +# Acre Contracts -Acre is a “liquid staking” solution that allows people to earn yield on their Bitcoin via yield farming on Ethereum. +Acre protocol smart contracts. + +[![Solidity](https://github.com/thesis/acre/actions/workflows/solidity.yaml/badge.svg?branch=main&event=push)](https://github.com/thesis/acre/actions/workflows/solidity.yaml) + +## Development + +### Installation + +This project uses [pnpm](https://pnpm.io/) as a package manager ([installation documentation](https://pnpm.io/installation)). + +To install the dependencies execute: + +```bash +pnpm install +``` + +### Testing + +To run the test execute: + +``` +$ pnpm test +``` + +### Deploying + +We deploy our contracts with +[hardhat-deploy](https://www.npmjs.com/package/hardhat-deploy) via + +``` +$ pnpm run deploy [--network ] +``` + +Check the `"networks"` entry of `hardhat.config.ts` for supported networks. + +## Contract Addresses + +The official mainnet and testnet contract addresses are listed below. + +### Mainnet + +TBD + +### Sepolia + +TBD