Add documentation for 0.1.9 (#27)

* Add documentation for 0.1.9

* Update docs for 0.1.9

* wip

* upd

* up

Author: adinhodovic

README.md

@@ -36,24 +36,9 @@ MIDDLEWARE = [
 
 ## Getting started
 
-Add settings for the experiments:
+Head over to the Django admin and add a new Google Optimize experiment. Add an experiment variant with the index 1 and the alias "new_design". Set the experiment cookie's active variant index to 1. Now the active variant for that experiment is 1 which is the experiment variant with the alias "new_design" that you created. Note: The experiment cookie only works in DEBUG mode and is used to avoid interacting with the session and testing the experiment variants via the Django admin.
 
-- id: Experiment ID required to identify variants for the experiment in templates
-- alias: Alias for the experiment ID, optional useful for clarity in templates when accessing experiment variants by key
-- variant_aliases: Aliases for each variant, each index represents a Optmize Experiment variant
-
-```py
-# django-google-optimize
-GOOGLE_OPTIMIZE_EXPERIMENTS = [
-    {
-        "id": "utSuKi3PRbmxeG08en8VNw",
-        "alias": "redesign",
-        "variant_aliases": {0: "old_design", 1: "new_design"},
-    }
-]
-```
-
-Now you can access the experiment in templates:
+Now you can access the experiment in templates by the experiment alias and the variant alias:
 
 ```django
 {% if request.google_optimize.redesign == "new_design" %}

docs/configuration.md

@@ -1,48 +1,54 @@
 # Configuration
 
-The configuration is a list of dicts and each dict consists of three fields, one being mandatory and the other two being optional:
+You can configure the Google Optimize experiments via the Django admin panel. There are three objects that you can add:
 
-- id(string, required): Experiment id required to identify each experiment in the cookie set by Google.
-- alias(string, optional): Alias for the experiment id, useful for clarity when accessing experiment variants by key.
-- variant_aliases(dict, optional): Aliases for each variant, consist of key-value variables. The key represents the index for each experiment variant. The value is the alias for the variant. Check your Google Optimize experiment to see which index represents what experiment variant.
+- Google Experiment.
+- Experiment Variant
+- Experiment Cookie
 
-## Single experiment
+The Google Experiment object contains of an experiment id and an optional alias which can used to alternatively reference the experiment in code.
 
-For a single experiment the settings could be the following:
+The Experiment Variant is optional and it is used to give each experiment variant an alias for easier usage in templates/views. If not added, the returned variant will be the index of the variant in the Google Optimize experiment cookie(_gaexp).
 
-```py
-# django-google-optimize
-GOOGLE_OPTIMIZE_EXPERIMENTS = [
-    {
-        "id": "utSuKi3PRbmxeG08en8VNw",
-        "alias": "redesign",
-        "variant_aliases": {0: "old_design", 1: "new_design"},
-    }
-]
+The Experiment Cookie is optional and it is only used in DEBUG mode. It aids in overriding or adding an experiment to the browser cookie(_gaexp). Replaces any interaction with the browser session while developing, making it possible to test out all your variants via the Django admin.
+
+## Sample Configuration
+
+Without an Google Experiment alias you will have to reference your experiment by id:
+
+```python
+    {% if request.google_optimize.k123ladwq == 0 %}
+    {% include "jobs/xyz_new.html" %}
+    {% endif %}
+```
+
+Instead of by experiment alias:
+
+```python
+    {% if request.google_optimize.redesign_header == 0 %}
+    {% include "jobs/xyz_new.html" %}
+    {% endif %}
 ```
 
-## Multiple experiments
-
-For multiple experiments the settings could be the following:
-
-```py
-# django-google-optimize
-GOOGLE_OPTIMIZE_EXPERIMENTS = [
-    {
-        "id": "3x8_BbSCREyqtWm1H1OUrQ",
-        "alias": "redesign_page",
-        "variant_aliases": {0: "old_design", 1: "new_design"},
-    },
-    {
-        "id": "7IXTpXmLRzKwfU-Eilh_0Q",
-        "alias": "redesign_header",
-        "variant_aliases": {0: "old_header", 1: "new_header"},
-    },
-]
+Without an variant alias you will have to reference your variant by index as:
+
+```python
+    {% if request.google_optimize.redesign_header == 0 %}
+    {% include "jobs/xyz_new.html" %}
+    {% endif %}
 ```
 
-## Notes
+Instead of by variant alias:
 
-If you do not set the alias you'll have to access the experiment variant by the Google Optimize id for the experiment.
+```python
+    {% if request.google_optimize.redesign_header == "New Background Color" %}
+    {% include "jobs/xyz_new.html" %}
+    {% endif %}
+```
 
-If you do not set the variant alias for a variant the index will be the variant returned.
+If you do not use the Experiment Cookie object when testing locally make sure to add the `_gaexp` cookie to the session:
+
+```txt
+Cookie Name: _gaexp
+Cookie Value GAX1.2.{experiment_id}.18147.{active_variant_index}
+```

docs/usage.md

@@ -2,7 +2,7 @@
 
 ## Usage in templates
 
-If you are redesigning major changes then you maybe would like to have two different templates. You can create a file that is called `jobs/xyz.html` that target two different files based on the experiment variant.
+If you are redesigning major changes then you maybe would like to have two different templates. You can create a file that is called `jobs/xyz.html` that include two different files based on the experiment variant.
 
 `jobs/xyz.html`