diff --git a/README.md b/README.md index b14ab12..741b3a3 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,42 @@ -## Foundry +## Template Repo (Foundry) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) - -[![CI Status](../../actions/workflows/test.yaml/badge.svg)](../../actions) - -**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** +This is a brief summary of the project. +What are its core features and what is its role in the bigger ecosystem -Foundry consists of: +Want to contribute to this project? +Check [CONTRIBUTING.md](CONTRIBUTING.md) -- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools). -- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data. -- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network. -- **Chisel**: Fast, utilitarian, and verbose solidity REPL. -## Documentation +#### Table of Contents +[Setup](#setup) +[Compilation](#compilation) +[Testing](#testing) +[Deployment](#deployment) +[Architecture](#architecture) +[License](#license) -https://book.getfoundry.sh/ - -## Usage - -### Build +## Compilation ```shell $ forge build ``` -### Test +### Testing ```shell $ forge test ``` -### Format - -```shell -$ forge fmt -``` - -### Gas Snapshots - -```shell -$ forge snapshot -``` - -### Anvil - -```shell -$ anvil -``` - -### Deploy +## Deployment ```shell $ forge script script/Counter.s.sol:CounterScript --rpc-url --private-key ``` -### Cast - -```shell -$ cast -``` - -### Help +## Architecture -```shell -$ forge --help -$ anvil --help -$ cast --help -``` +Add explanations and graphs to help poeple understand how the contracts of this repo work together. ---- +## License +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Copyright (C) 2023 PT Services DMCC