diff --git a/README.markdown b/README.markdown index e644356..7180cd5 100644 --- a/README.markdown +++ b/README.markdown @@ -1,11 +1,13 @@ A tiny library for submitting external HITs on Mechanical Turk. -It creates a global JavaScript object, `turk`, that has these four properties: +It creates a global JavaScript object, `turk`, that has these five properties: -* `previewMode`: true if we're currently in the external HIT preview mode. +* `hitId`: the HIT ID variable. * `assignmentId`: the assignment ID variable. * `workerId`: the worker ID variable. -* `turkSubmitTo`: the Mechanical Turk submission server (either production or sandbox).. +* `previewMode`: true if we're currently in the external HIT preview mode. +* `turkSubmitTo`: the Mechanical Turk submission server (either production or sandbox). + These variables get read from `window.location.href`. If they aren't in `window.location.href`, the scrip script also tries `document.referer`, so you can conceivably split a task across two different pages. The script provides a single method: