From 9371f56dbc8ffded9764adf0b7b3f125b6f2cbf3 Mon Sep 17 00:00:00 2001
From: Aurelien Vaillant <a.vaillant.moderlab@gmail.com>
Date: Mon, 16 May 2022 11:01:40 +0200
Subject: [PATCH] Add some documentation

---
 readme.md | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/readme.md b/readme.md
index f5c58e2..7c91ccd 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,7 @@
 ![Blender](https://img.shields.io/badge/blender-3.1.0-sucess)
 
 # Blender Addon
-Template repository about blender addon. To used-it, clone this repository and rename the folder "blender_addon_folder" with your addon name.
+This repository is a toolbox to create a new blender addon. To used-it, clone this repository and rename the folder "blender_addon_folder" with your addon name.
 It's important to change some files :
 - [x] Update the file "tests/main.py", line 29, set your addon name.
   ```python
@@ -14,12 +14,27 @@ It's important to change some files :
 
 > ⚠️ It's more easy to use the "_" with your addon folder name, the "-" character can be problematic with python use. 
 
+All features covered with this template are :
+- [x] Generate addon release (.zip archive)
+- [x] Generate preset release (.zip archive)
+- [x] Update addon version (bl info) with tag name
+- [x] Execute unit test with Github Action (check if the addon can be installed with blender)
+- [x] Configuration with Pycharm to test locally
+
+
+## Unit Test
+All unit tests call docker image [stilobique/blender](https://hub.docker.com/repository/docker/stilobique/blender). It's a simple ubuntu image with blender compile. 
+If you want change the blender version tested, edit the `main.py` inside the `tests` folder ; change the tag version with your requested tag.
+
+`````python
+class Container(enum.Enum):
+    """Enumerate about the Geometry node"""
+    BLENDER = ContainerObject(name='Blender', image='stilobique/blender', tag='3.1.2')
+`````
 
-# Unit Test
-All unit tests call docker image [stilobique/blender:latest](https://hub.docker.com/repository/docker/stilobique/blender).
 
 # Addons/Plugins dependency
-Update json file `tests/dependency.json` with name, archive and repository Github path. Each entry requiert `archive 
+Update json file `tests/dependency.json` with name, archive and repository Github path. Each entry require `archive 
 name`, the repository url path '{owner}/{repo}' and optional parameter if the release needed to be a prerelease.
 
 > ⛔ The `moderlab_plugin` need to be on last entry.