From c723da37ea109044b3d7bea287a6095606809107 Mon Sep 17 00:00:00 2001
From: Override-6 <maximebatista18@gmail.com>
Date: Sat, 7 Jan 2023 22:24:58 +0100
Subject: [PATCH] added readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f87aec2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Docdeployer
+
+Usage:
+```yml
+steps:
+  - name: swagger-doc
+    image: hub.codefirst.iut.uca.fr/maxime.batista/codefirst-docdeployer
+    commands:
+      - /entrypoint.sh <arguments>
+```
+
+## `entrypoint.sh`
+
+This command generates the documentation and deploys it on your CodeDoc space
+
+### arguments
+
+- -d --dir [dir] path to the documentation root - required
+- -t --type [docusaurus|doxygen|swagger] type of documentation generator to use. - required
+- -l --dest [dir] path to where to put the documentation outputs in your repository's CodeDoc space - optional !! cannot be absolute !!
+
+usage examples :
+
+/entrypoint.sh -d ./documentation/api -t swagger -l api_documentation
+/entrypoint.sh -d ./documentation/app -t docusaurus -l application_documentation
+/entrypoint.sh -d ./src -t doxygen -l sourcecode_documentation 
+