Skip to content

Commit

Permalink
docs: adding health check command to README
Browse files Browse the repository at this point in the history
  • Loading branch information
julien51 committed Feb 28, 2025
1 parent 9d7a010 commit a1e7fec
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ Build all packages:
yarn build
```

To execute commands inside the repo, we use the pattern `yarn workspace <workspace name> <command>`
Next, to execute commands inside the repo, we use the pattern `yarn workspace <workspace name> <command>`

```
# build the contracts
# build the contracts only
yarn workspace @unlock-protocol/smart-contracts build
# validate lint for paywall
Expand All @@ -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/).
Expand Down

0 comments on commit a1e7fec

Please sign in to comment.