diff --git a/README.md b/README.md index d7bac05c1ff..5faa7c2e9e1 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,10 @@ Build all packages: yarn build ``` -To execute commands inside the repo, we use the pattern `yarn workspace ` +Next, to execute commands inside the repo, we use the pattern `yarn workspace ` ``` -# build the contracts +# build the contracts only yarn workspace @unlock-protocol/smart-contracts build # validate lint for paywall @@ -61,6 +61,14 @@ yarn workspace @unlock-protocol/paywall lint # etc. ``` +## Protocol Health check + +Anyone can run a full protocol check from their command line (please follow the steps above to install the dependencies and build the packages first!) + +``` +yarn workspace @unlock-protocol/networks check:verify +``` + ### The protocol You can run a local version of the protocol using [Docker](https://docs.docker.com/install/).