diff --git a/README.md b/README.md index f40ffe3..660d785 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## Solidity Development Template(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) +[![CI Status](https://github.com/wschwab/sol-template/actions/workflows/test.yml/badge.svg)](https://github.com/wschwab/sol-template/actions/workflows/test.yml) This template repo is a quick and easy way to get started with a new Solidity project. It comes with a number of features that are useful for developing and deploying smart contracts. Such as pre-commit hooks for formatting, auto generated documentation, and more @@ -48,6 +48,8 @@ Follow these steps to set up your local environment for development: - Test contracts: `forge test` - Run coverage: `forge coverage` +Note: the CI badge above is configured to run from `github.com/wschwab/sol-template/`. When forking to use this template, the badge should be modified (via the url embedded in the Markdown at the beginning of the README) to point at the target repo. + ## Pre-commit Hooks Follow the [installation steps](#install) to enable pre-commit hooks. To ensure consistency in our formatting `pre-commit` is used to check whether code was formatted properly and the documentation is up to date. Whenever a commit does not meet the checks implemented by pre-commit, the commit will fail and the pre-commit checks will modify the files to make the commits pass. Include these changes in your commit for the next commit attempt to succeed. On pull requests the CI checks whether all pre-commit hooks were run correctly.