Skip to content

Commit

Permalink
πŸ“š Update Template README
Browse files Browse the repository at this point in the history
  • Loading branch information
JaredBorders committed Sep 20, 2023
1 parent c7cadd9 commit 209fa96
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@

Template for a foundry project.

## Getting Started

1. Create an `.env` file using the `.env.example` file as a template
2. Update `package.json` with your project name, description, etc.
3. Update the `README.md` with your project name, description, etc.
4. Add required **Repository Secrets** to your github repository settings
> Navigate to `Settings > Secrets and variables > Actions` and add whatever secrets are required for your project's CI.
> For example, in this project the following secrets are required: `OPTIMISM_GOERLI_RPC_URL` and `ETHERSCAN_API_KEY`. See `.github/workflows/*` for more details.
## Contracts

> `tree src/`
Expand Down

0 comments on commit 209fa96

Please sign in to comment.