From 6f15d1205befe8194f870d51ec7e29fc703c084f Mon Sep 17 00:00:00 2001
From: Th3maz1ng <re.hertz@laposte.net>
Date: Sun, 17 Mar 2019 10:40:03 +0100
Subject: [PATCH] =?UTF-8?q?Mettre=20=C3=A0=20jour=20'README.md'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1b8b3e1..5205170 100644
--- a/README.md
+++ b/README.md
@@ -70,10 +70,38 @@ Arduino based project running on my custom made board
 |_FTP
 |_LOGS
 |_WWW
+```
+### Example of a config file structure (.CFG) :
+```
+#This line is a comment and will be ignored
+#All comments should be at the top of the file
+#The parameter names are case sensitive /!\
+
+this_is_the_parameter_name : this_is_a_numeric_value
+'this is the parameter name' : this_is_a_numeric_value
+this_is_the_parameter_name : 'this is a string value'
+'this is the parameter name' : 'this is a string value'
+
+```
+### For AP.CFG it would be :
+```
+#This config file stores the configuration needed to set the AP
+#up for the ESP8266SwissArmyBoad
+#If this file is not present or if there is an error at parsing time
+#default values will be used instead.
+#If the password is an empty string aka '', the network will be open
+
+SSID : 'ESP8266SwissArmyBoard'
+PASSWORD : 'APassWord'
+CHANNEL : 1
+SSID_HIDDEN : 'true'
+AP_MAX_CONNECTION : 4
+
 ```
 ### Things to do :
 * Screen Manager 	✓
-* µSDcard File System
+* µSDcard File System (In progress)
+* File Config Parser
 * RTC Manager 	✓
 * RTC FLASH Manager
 * FTP Service