From 2e26d60150e1b5ccb4e05482be2abc7e048142e1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rapha=C3=ABl=20Vinot?= <raphael@vinot.info>
Date: Fri, 19 Jul 2024 14:34:28 +0200
Subject: [PATCH] new: very basic documentation

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

diff --git a/README.md b/README.md
index adbcae7..20a08a6 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,19 @@ pip install pyvulnerabilitylookup
 You can use the `vulnerability_lookup` command:
 
 ```bash
+$ vulnerability_lookup -h
+usage: vulnerability_lookup [-h] --url URL (--redis_up | --vulnerability VULNERABILITY)
+
+Query a thing.
+
+options:
+  -h, --help            show this help message and exit
+  --url URL             URL of the instance.
+  --redis_up            Check if redis is up.
+  --vulnerability VULNERABILITY
+                        Get a vulnerability.
 ```
 
 ### Library
 
-See [API Reference]()
+See [API Reference](https://pyvulnerabilitylookup.readthedocs.io/en/latest/api_reference.html)