add references to original paper in docs

jspsych · Nov 25, 2024 · 31db640 · 31db640
1 parent 31b8896
commit 31db640
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/plugin-headphone-check/README.md b/packages/plugin-headphone-check/README.md
@@ -2,7 +2,7 @@
 
 ## Overview
 
-Allows for one to check if a participant is wearing headphones using an auditory task.
+Allows for one to check if a participant is wearing headphones using an auditory task. In the default configuration, participants listen to 6 audio samples with 3 tones each, and asked for which is the quietest. Upon meeting a threshold (at least 5), we can accurately conclude that the participant is wearing headphones, as per the findings in the [paper describing the original HeadphoneCheck](http://mcdermottlab.mit.edu/papers/Woods_etal_2017_headphone_screening.pdf).
 
 ## Loading
 

diff --git a/packages/plugin-headphone-check/package.json b/packages/plugin-headphone-check/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@jspsych-contrib/plugin-headphone-check",
   "version": "0.0.1",
-  "description": "Allows for one to check if a participant is wearing headphones using an auditory task.",
+  "description": "Allows for one to check if a participant is wearing headphones using an auditory task. ([Woods et al., 2017](http://mcdermottlab.mit.edu/papers/Woods_etal_2017_headphone_screening.pdf))",
   "type": "module",
   "main": "dist/index.cjs",
   "exports": {