From 9e98700eb8f57ed073f3d46122f4c8a1fc8e1ffa Mon Sep 17 00:00:00 2001
From: GnomeZworc <nicolas.boufidjeline@g3e.fr>
Date: Mon, 27 Oct 2025 13:35:47 +0100
Subject: [PATCH] init: add documantation

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
---
 docs/README.md            |  8 ++++++++
 docs/dev.md               |  1 +
 docs/release.md           | 12 ++++++++++++
 docs/release/.template.md | 15 +++++++++++++++
 4 files changed, 36 insertions(+)
 create mode 100644 docs/README.md
 create mode 100644 docs/dev.md
 create mode 100644 docs/release.md
 create mode 100644 docs/release/.template.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..364808c
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,8 @@
+# Documentation
+
+[Names](https://www.monde-animal.fr/liste-animaux-a-z/)
+
+- [how to dev](./dev.md)
+- [how to release](./release.md)
+
+# Release list
\ No newline at end of file
diff --git a/docs/dev.md b/docs/dev.md
new file mode 100644
index 0000000..11dc655
--- /dev/null
+++ b/docs/dev.md
@@ -0,0 +1 @@
+# Developpement environement
\ No newline at end of file
diff --git a/docs/release.md b/docs/release.md
new file mode 100644
index 0000000..d5bf821
--- /dev/null
+++ b/docs/release.md
@@ -0,0 +1,12 @@
+# How to release
+
+```
+curl https://git.g3e.fr/H6N/tools/raw/branch/main/scripts/release.sh | bash -s - -t [Version] -n [Name] -c
+
+update all necessary file :
+- ./docs/release/next_release.md
+- ./docs/README.md
+- ./.env
+
+curl https://git.g3e.fr/H6N/tools/raw/branch/main/scripts/release.sh | bash -s -
+```
\ No newline at end of file
diff --git a/docs/release/.template.md b/docs/release/.template.md
new file mode 100644
index 0000000..3c4bf95
--- /dev/null
+++ b/docs/release/.template.md
@@ -0,0 +1,15 @@
+# NAME VERSION
+
+## Upgrade Procedure
+
+```
+git fetch --all
+git checkout VERSION
+docker compose pull
+docker compose up -d
+```
+
+## Release feature
+
+- ...
+- ...
\ No newline at end of file