From 3fb043210ef509dbf340f95d15f0860d5957789c Mon Sep 17 00:00:00 2001
From: isUnknown <adrien.payet@outlook.com>
Date: Tue, 17 Dec 2024 17:55:55 +0100
Subject: [PATCH] doc

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

diff --git a/README.md b/README.md
index 7875a83..878e440 100644
--- a/README.md
+++ b/README.md
@@ -130,3 +130,71 @@ export default routes;
 ```
 
 **The name of the component should be exactly the same as the name of the template, including its case**. This project follows the Vue convention to use pascal case
+
+### Files data
+
+Files data must be prepared using the `getFileData()` function, which takes a `Kirby\Cms\File` class as a parameter. It is located in `public/site/plugins/helpers/index.php`.
+
+### Steps
+
+Each project is composed of different steps, which are ordered regarding project process and may be required (\*) or optional :
+
+- Client brief\* :
+
+```json
+{
+  "id": "clientBrief",
+  "label": "Brief client",
+  "slug": "client-brief"
+}
+```
+
+- Proposal\* :
+
+```json
+{
+  "id": "proposal",
+  "label": "Offre commerciale",
+  "slug": "proposal"
+}
+```
+
+- Extended Brief\*
+
+```json
+{
+  "id": "extendedBrief",
+  "label": "Brief enrichi",
+  "slug": "extended-brief"
+}
+```
+
+- Industrial ideation
+
+```json
+{
+  "id": "industrialIdeation",
+  "label": "Idéation industrielle",
+  "slug": "industrial-ideation"
+}
+```
+
+- Virtual sample\*
+
+```json
+{
+  "id": "virtualSample",
+  "label": "Échantillon industriel",
+  "slug": "virtual-sample"
+}
+```
+
+- Physical sample
+
+```json
+{
+  "id": "physicalSample",
+  "label": "Échantillon physique",
+  "slug": "physical-sample"
+}
+```