From ab91c1c277ef76ed83eb287261fd4610f306c7a3 Mon Sep 17 00:00:00 2001
From: Loris Perret <l.perret@openium.fr>
Date: Fri, 8 Mar 2024 09:57:43 +0100
Subject: [PATCH] Update README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++----
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 580516f..435ac6b 100644
--- a/README.md
+++ b/README.md
@@ -133,7 +133,7 @@ swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/tags.txt" \
 6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppTags+GreatApp.swift`)
 7. `--static-members` *(optional)*: generate static properties or not
 
-> ⚠️ If extension name is not set or is `Tags`, it will generate the following typaloas  `typealias Tags = String`.
+> ⚠️ If extension name is not set or is `Tags`, it will generate the following typealias `typealias Tags = String`.
 
 
 ## Analytics
@@ -141,7 +141,7 @@ swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/tags.txt" \
 Analytics will generate all you need to analyze UX with Matomo or Firebase Analytics. Input files are formatted in YAML. This command will generate a manager for each target and an AnalyticsManager. This is this one you will need to use. And it will generate a method for all tags you have declared in the YAML file. Next, you will need to use the `configure()` method of AnalyticsManager and if you want to use matomo to set up the `siteId` and the `url` of the site.
 
 ```sh
-swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/tags.txt" \
+swift run -c release ResgenSwift analytics $FORCE_FLAG "./Tags/analytics.yml" \
  --target "matomo firebase" \
  --extension-output-path "./Analytics/Generated" \
  --extension-name "AppAnalytics" \
@@ -159,7 +159,7 @@ swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/tags.txt" \
 6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppAnalytics+GreatApp.swift`)
 7. `--static-members` *(optional)*: generate static properties or not
 
-> ⚠️ If extension name is not set or is `Analytics`, it will generate the following typaloas  `typealias Analytics = String`.
+> ⚠️ If extension name is not set or is `Analytics`, it will generate the following typealias `typealias Analytics = String`.
 
 ### YAML
 
@@ -186,7 +186,7 @@ swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/tags.txt" \
 7. `comments` *(optional)*
 8. `parameters` *(optional)*
 
- **Parameters**
+**Parameters**
 
 You can use parameters in generate methods. 
 
@@ -199,6 +199,24 @@ You can use parameters in generate methods.
 This is section is equivalent of `%s | %d | %f | %@`. You can put the content of the parameter in *name*, *path*, *action*, *category*.
 You need to put `_` + `NAME OF THE PARAMETER` + `_` in the target and which target you want in the value of `replaceIn`. (name need to be in uppercase)
 
+Example:  
+```
+events:
+  id: id_of_tag
+  name: _TITLE_
+  tags: ios,droid
+  parameters:
+    - name: title
+      type: String
+      replaceIn: name
+```
+
+In this sample, we want to add the parameter `title` in the field `name`. So, we need to place `_TITLE_` in the field `name`.
+
+The generated method will be:  
+```
+logIdOfTag(title: String)
+```
 
 ## Images
 
@@ -287,6 +305,15 @@ tags:
   extensionName: String?
   extensionSuffix: String?
   staticMembers: Bool?
+
+analytics:
+- 
+  inputFile: String
+  target: String
+  extensionOutputPath: String
+  extensionName: String?
+  extensionSuffix: String?
+  staticMembers: Bool?
 ```
 
 ### Multiple configurations