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 !! cannot be absolute !!** +Note ! +For swagger, you have to pass the configuration file instead of a directory + usage examples : ```