From ed5a1b001dab68a42efa8da7a4aa66cb07cc7a9e Mon Sep 17 00:00:00 2001
From: teddy <teddy@defi.sucks>
Date: Mon, 16 Dec 2024 08:47:41 -0300
Subject: [PATCH] docs: describe how to run natspec-smells in CI (#62)

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ec2656e..2a88749 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,18 @@ npx @defi-wonderland/natspec-smells --include "src/**/*.sol"
 
 ## Verify your natspec in CI
 
-_Soon to come._
+With the setup defined above, it's possible to invoke the executable from within a github workflow, as long as node.js is available in that environment:
+
+```
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+
+      - name: Check natspec
+        run: yarn natspec-smells
+```
 
 ## Options