From bbb1c4184b46c4e237a3261b40dbe4ed0a9f61c4 Mon Sep 17 00:00:00 2001
From: Alexandre Dulaunoy <a@foo.be>
Date: Sun, 3 Nov 2019 15:32:57 +0100
Subject: [PATCH] chg: [doc] clarification

---
 README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a0f9553..644f867 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # git-vuln-finder
 
-Finding potential software vulnerabilities from git commit messages.
+Finding potential software vulnerabilities from git commit messages. The output format is a JSON with the associated commit which could contain a fix regarding
+a software vulnerability. The search is based on a set of regular expressions against the commit messages.
 
 # Requirements
 
@@ -23,6 +24,8 @@ optional arguments:
 More info: https://github.com/cve-search/git-vuln-finder
 ~~~
 
+## A sample partial output from Curl git repository
+
 ~~~bash
 python3 finder.py -r /home/adulau/git/curl | jq .
 ...