Readme updated

README.md

@@ -1,30 +1,78 @@
-# abtest2
+# abtest2 TYPO3 Extension
+
+Extension for A/B-Tests
 
 This extension supports TYPO3 administrators in performing A/B tests. This is useful when a site owner want to measure whether a new version improves or reduces user interaction compared to the current version.
 
-Page properties get a new field "B Page" where you can provide the alternative page version. If the page is requested by the user, the extension checks wheter there is a B version specified. If this is the case, the version is selected by random. A cookie is set that remembers which version the user got (so there is no flip-flop if the user requests the page repeatedly). Once the cookie expires, the user is back to random at the next request.
+### Features of the extension
+
+1. Caching of each page version
+2. A real 50/50% chance. That means: No selection by random, because of the unreliable random method. So the versions are always taken alternately.
+3. Complete different content with same page id. So only one URL for two versions. The displayed version is determined by the cookie value.
+
+#### More information
+
+Page properties get a new field "B Page" where you can provide the alternative page version. If the page is requested by the user, the extension checks wheter there is a B version specified. If this is the case, the version is selected by "random". A cookie is set that remembers which version the user got (so there is no flip-flop if the user requests the page repeatedly). Once the cookie expires, the user is back to random at the next request.
 
 Additional header information may be specified both for the original version as well as for the B version. This allows to track version differences in a web analysis tool such as Analytics. 
 
 
-#### Example for Google Analytics:
-
-In Google Analytics you can different your A and B site with 2 segments.
-
-First you have to add a "Custom Definition" under your property settings.
-Create a "Custom Dimension" with name "Variant A or B" for example. Set "Scope" to "Hit".
-Then create a new advanced segment for your data and give it a segment name. Under advanced conditions add 2 filters.
-1. filter: "Page" - "exactly matches" - "/mysite.html"
-2. filter: "Custom Dimensions" (choose your previously created dimension "Variant A or B") - "contains" - "Variant B"
-
-##### Additional Header Information:
-```javascript
-<script>
-ga('send', 'pageview', { 'dimension1':  'Variant B' });
-</script>
-```
-(dimension1 is the index of your dimension)
-
 #### Demo
 
-![Demo](https://github.com/svewap/abtest2/raw/master/Resources/Public/Images/Demo/demo.gif)
+![Demo](https://raw.githubusercontent.com/svewap/abtest2/master/Documentation/Images/demo.gif)
+
+#### Example for Google Tag Manager:
+
+You have two options to define the parameter: By page settings or by TypoScript:
+
+##### Additional Header Information at page settings
+
+On original page (version A):
+
+```javascript
+<script>
+dataLayer.push({'variant': 'a'});
+</script>
+```
+
+On version B:
+
+```javascript
+<script>
+dataLayer.push({'variant': 'b'});
+</script>
+```
+
+
+##### TypoScript
+
+```typo3_typoscript
+[globalVar = GP:abtest = a]
+  page.headerData.129 = TEXT
+  page.headerData.129.value (
+<script>
+  dataLayer = [{
+    'variant': 'a'
+  }];
+</script>
+  )
+[global]
+[globalVar = GP:abtest = b]
+  page.headerData.129 = TEXT
+  page.headerData.129.value (
+<script>
+  dataLayer = [{
+    'variant': 'b'
+  }];
+</script>
+  )
+[global]
+
+page.headerData.130 = TEXT
+page.headerData.130.value (
+<!-- Google Tag Manager -->
+....
+<!-- End Google Tag Manager -->
+)
+```
+