diff --git a/README.md b/README.md index daaec4d6c..42b361c8d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ To install, follow the [installation instructions for your Operating System](htt ## Optional Link Checking -We validate that all links on the docs site do not 404 by using a tool called [Muffet](https://github.com/raviqqe/muffet) along with [Actions](https://github.com/features/actions). If you're creating a lot of new links, or editing a lot of existing links, you may optionally run Muffet locally before pushing your commits. This will save a lot of time of pushing a build, waiting for the Action to run, finding you have a broken link, fixing it, pushing a new change etc. +We validate that all links on the docs site work (do not 404) using a tool called [Muffet](https://github.com/raviqqe/muffet) along with [Actions](https://github.com/features/actions). If you're creating a lot of new links, or editing a lot of existing links, you may optionally run Muffet locally before pushing your commits. This will save a lot of time of pushing a build, waiting for the Action to run, finding you have a broken link, fixing it, pushing a new change etc. - Install [Go](https://golang.org/doc/install) as a prerequisite - Install Muffet: `go get -u github.com/raviqqe/muffet`