From c8dedcc26e65fbaed703b134f32b87b0ecfe9ed3 Mon Sep 17 00:00:00 2001
From: sripwoud <me@sripwoud.xyz>
Date: Wed, 7 Aug 2024 16:04:35 +0200
Subject: [PATCH] docs: update README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 4d2c091..ed796c1 100644
--- a/README.md
+++ b/README.md
@@ -176,6 +176,22 @@ or to automatically format the code:
 yarn format:write
 ```
 
+### Linting
+
+```bash
+yarn lint
+```
+
+Will lint all the packages with [`solhint`](https://github.com/protofire/solhint)
+
+### Static Analysis
+
+```bash
+yarn slither
+```
+
+Will perform a static analysis of all the contracts with [`slither`](https://github.com/crytic/slither) to identify potential vulnerabilities.
+
 ### Conventional commits
 
 ZK-Kit uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). A [command line utility](https://github.com/commitizen/cz-cli) to commit using the correct syntax can be used by running: