From 26d27fc7c262a99716c6afac7b0f1bc5bc356a7b Mon Sep 17 00:00:00 2001
From: Override-6 <maximebatista18@gmail.com>
Date: Sun, 8 Jan 2023 17:53:29 +0100
Subject: [PATCH] added clarifications on the swagger generator

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

diff --git a/README.md b/README.md
index f19bd40..541114c 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,9 @@ This command generates the documentation and deploys it on your CodeDoc space
 - `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required**
 - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional <u>!! cannot be absolute !!</u>**
 
+Note !  
+For swagger, you have to pass the configuration file instead of a directory
+
 usage examples :
 
 ```