From 9f27d9f4adacbc42a64bf8fbaab2fc32964161cb Mon Sep 17 00:00:00 2001
From: Gas One Cent <86567384+gas1cent@users.noreply.github.com>
Date: Thu, 11 Jan 2024 15:53:48 +0400
Subject: [PATCH] docs: update readme

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

diff --git a/README.md b/README.md
index 0e23aac..f374ed6 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 
 # Natspec Smells
 
-Some description will be written here.
+Just like code, documentation can smell, too. `natspec-smells` aims to help automatically identify missing or incomplete natspec.
 
 ## Usage
 
@@ -12,6 +12,20 @@ As simple as it gets, run:
 npx @defi-wonderland/natspec-smells --contracts ./solidity
 ```
 
+Example output:
+```text
+sample-data/BasicSample.sol:16
+BasicSample:constructor
+  Natspec is missing
+
+sample-data/BasicSample.sol:21
+BasicSample:BasicSample_BasicEvent
+  @param _param1 is missing
+
+sample-data/BasicSample.sol:8
+BasicSample:TestStruct
+  @return someAddress is missing
+```
 
 ## Options
 
@@ -23,11 +37,10 @@ Base directory to be used.
 
 Default: `./`
 
-
 ## Contributors
 
 Natspec Smells was built with ❤️ by [Wonderland](https://defi.sucks).
 
 Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.
 
-[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.
\ No newline at end of file
+[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.