updated README

Author: jackbrookes

Assets/UXF/Examples/Basic/BasicExample.unity

@@ -214,12 +214,12 @@ Prefab:
     - target: {fileID: 224130118367839794, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 2}
       propertyPath: m_AnchorMax.x
-      value: 0
+      value: 1
       objectReference: {fileID: 0}
     - target: {fileID: 224130118367839794, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 2}
       propertyPath: m_AnchorMax.y
-      value: 0
+      value: 1
       objectReference: {fileID: 0}
     - target: {fileID: 224286096967890162, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 2}
@@ -244,7 +244,7 @@ Prefab:
     - target: {fileID: 224546371281550106, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 2}
       propertyPath: m_SizeDelta.y
-      value: 75
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 224546371281550106, guid: 0a3b6392f04558844bd340e68ced1ff9,
         type: 2}

README.md

@@ -1,7 +1,14 @@
 ![Unity Experiment Framework](media/banner.png)
 
 # UXF - Unity Experiment Framework
-A set of C# scripts which simplifies management of human-based experiments developed in Unity. This is the development project, if you want to download the package, see [Releases](https://github.com/jackbrookes/unity-experiment-manager/releases). 
+A set of C# scripts which simplifies management of human-based experiments developed in Unity. This is the development project, if you want to download the package, see [Releases](https://github.com/jackbrookes/unity-experiment-framework/releases). 
+
+## Get started
+
+Import the latest ```.unitypackage``` [release](https://github.com/jackbrookes/unity-experiment-framework/releases) to your existing Unity project.
+
+Note: Users must change API Compatibility Level to .NET 2.0 in Unity player settings. 
+
 
 ## Features
 
@@ -47,23 +54,22 @@ UXF classes will be useful in two main parts of your project:
 ```csharp
 class ExperimentBuilder : Monobehaviour
 {
-    // set this to your ExperimentSession instance in the inspector
-    public ExpMngr.ExperimentSession session;
+    // set this to your Session instance in the inspector
+    public UXF.Session session;
 
-    // call this function from ExperimentSession OnSessionBegin UnityEvent in its inspector
-    public void GenerateAndRun() 
-    {
-        // Creating a block
-        var myBlock = new ExpMngr.Block(session); 
-
-        // Creating 10 trials within our block
-        for (int i = 0; i < 10; i++)
-            new ExpMngr.Trial(myBlock);
+    // assign this method to the Session OnSessionBegin UnityEvent in its inspector
+    public void GenerateAndRun(UXF.Session session) 
+    {       
+        // Creating a block of 10 trials
+        var myBlock = session.CreateBlock(10);
 
         // Add a new setting to trial 1, here just as an example we will apply a setting of "color" "red" 
-        var firstTrial = myBlock.GetTrial(1);//trial number is not 0 indexed
+        var firstTrial = myBlock.GetTrial(1); //trial number is not 0 indexed
         firstTrial.settings["color"] = "red";
 
+        // Save session instance reference
+        this.session = session;
+
         // Run first trial
         session.nextTrial.Begin();
     }
@@ -79,11 +85,12 @@ class ExperimentBuilder : Monobehaviour
 ```csharp
 class SceneManipulator : MonoBehaviour
 {
-    // set this to your ExperimentSession instance in the inspector
-    public ExpMngr.ExperimentSession session;
+    public UXF.Session session;
 
-    // call this function from ExperimentSession OnTrialBegin UnityEvent in its inspector
-    public void RunTrial(ExpMngr.Trial trial)
+    ...
+
+    // assign this method to the Session OnTrialBegin UnityEvent in its inspector
+    public void ShowStimulus(UXF.Trial trial)
     {
         // pull out the color we applied for this trial
         string colorManipulation = (string) trial.settings["color"];
@@ -93,7 +100,7 @@ class SceneManipulator : MonoBehaviour
     }
 
     // this could trigger on some user behaviour, collecting their score in a task
-    public void EndTrial(int score)
+    public void RecordResultsAndEnd(int score)
     {
         // store their score
         session.currentTrial.results["score"] = score;
@@ -108,14 +115,6 @@ class SceneManipulator : MonoBehaviour
 See `Assets/ExpMngr/ExampleScript.cs` for another simple example.
 
 
-
-## Get started
-
-Download the project folder and open in Unity. Alternatively import the latest ```.unitypackage``` [release](https://github.com/jackbrookes/unity-experiment-manager/releases) to your existing Unity project.
-
-Note: Users must change API Compatibility Level to .NET 2.0 in Unity player settings. 
-
-
 ## Development
 
 This project is developed under Unity 2017.3.0f3.