added readme.md for every package + changeset

.changeset/weak-turkeys-vanish.md

@@ -0,0 +1,61 @@
+---
+"@jspsych/test-utils": patch
+"@jspsych/extension-mouse-tracking": patch
+"@jspsych/extension-record-video": patch
+"@jspsych/extension-webgazer": patch
+"@jspsych/plugin-animation": patch
+"@jspsych/plugin-audio-button-response": patch
+"@jspsych/plugin-audio-keyboard-response": patch
+"@jspsych/plugin-audio-slider-response": patch
+"@jspsych/plugin-browser-check": patch
+"@jspsych/plugin-call-function": patch
+"@jspsych/plugin-canvas-button-response": patch
+"@jspsych/plugin-canvas-keyboard-response": patch
+"@jspsych/plugin-canvas-slider-response": patch
+"@jspsych/plugin-categorize-animation": patch
+"@jspsych/plugin-categorize-html": patch
+"@jspsych/plugin-categorize-image": patch
+"@jspsych/plugin-cloze": patch
+"@jspsych/plugin-external-html": patch
+"@jspsych/plugin-free-sort": patch
+"@jspsych/plugin-fullscreen": patch
+"@jspsych/plugin-html-audio-response": patch
+"@jspsych/plugin-html-button-response": patch
+"@jspsych/plugin-html-keyboard-response": patch
+"@jspsych/plugin-html-slider-response": patch
+"@jspsych/plugin-html-video-response": patch
+"@jspsych/plugin-iat-html": patch
+"@jspsych/plugin-iat-image": patch
+"@jspsych/plugin-image-button-response": patch
+"@jspsych/plugin-image-keyboard-response": patch
+"@jspsych/plugin-image-slider-response": patch
+"@jspsych/plugin-initialize-camera": patch
+"@jspsych/plugin-initialize-microphone": patch
+"@jspsych/plugin-instructions": patch
+"@jspsych/plugin-maxdiff": patch
+"@jspsych/plugin-mirror-camera": patch
+"@jspsych/plugin-preload": patch
+"@jspsych/plugin-reconstruction": patch
+"@jspsych/plugin-resize": patch
+"@jspsych/plugin-same-different-html": patch
+"@jspsych/plugin-same-different-image": patch
+"@jspsych/plugin-serial-reaction-time": patch
+"@jspsych/plugin-serial-reaction-time-mouse": patch
+"@jspsych/plugin-sketchpad": patch
+"@jspsych/plugin-survey": patch
+"@jspsych/plugin-survey-html-form": patch
+"@jspsych/plugin-survey-likert": patch
+"@jspsych/plugin-survey-multi-choice": patch
+"@jspsych/plugin-survey-multi-select": patch
+"@jspsych/plugin-survey-text": patch
+"@jspsych/plugin-video-button-response": patch
+"@jspsych/plugin-video-keyboard-response": patch
+"@jspsych/plugin-video-slider-response": patch
+"@jspsych/plugin-virtual-chinrest": patch
+"@jspsych/plugin-visual-search-circle": patch
+"@jspsych/plugin-webgazer-calibrate": patch
+"@jspsych/plugin-webgazer-init-camera": patch
+"@jspsych/plugin-webgazer-validate": patch
+---
+
+added readme for visibility on npmjs.com

examples/README-template.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Plugin Description
+
+The XXXXXX plugin does XXXXXX.
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this plugin is available [here](https://www.jspsych.org/latest/plugins/xxxxxx).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.

packages/extension-mouse-tracking/README.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Extension Description
+
+The mouse-tracking extension supports recording `x` and `y` coordinates, along with the time of [mousemove events](https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event), [mousedown events](https://developer.mozilla.org/en-US/docs/Web/API/Element/mousedown_event), and [mouseup events](https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseup_event). It also allows recording of the [bounding rectangle](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect) of elements on the screen to support the calculation of mouse events relative to various elements.
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this extension is available [here](https://www.jspsych.org/latest/extensions/mouse-tracking).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.

packages/extension-record-video/README.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Extension Description
+
+The record-video extension records video from the participant's webcam during a trial, storing it in base 64 format. This is a text-based representation of the video which can be converted into others.
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this extension is available [here](https://www.jspsych.org/latest/extensions/record-video).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.

packages/extension-webgazer/README.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Extension Description
+
+The webgazer extension supports eye tracking through the [Webgazer](https://webgazer.cs.brown.edu/) library. For examples of how to use this extension, see the [eyetracking overview](https://www.jspsych.org/latest/overview/eye-tracking/).
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this extension is available [here](https://www.jspsych.org/latest/extensions/webgazer).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.

packages/plugin-animation/README.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Plugin Description
+
+The animation plugin displays a sequence of images at a fixed frame rate. The sequence can be looped a specified number of times, and the participant is free to respond at any time during the animation, while recording the time of the response.
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this plugin is available [here](https://www.jspsych.org/latest/plugins/animation).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.

packages/plugin-audio-button-response/README.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Plugin Description
+
+The audio-button-response plugin plays audio files and records responses generated with a button click. The audio will be played using the WebAudio API, allowing for reasonably precise timing of the playback by measuring it against the WebAudio specific clock. If WebAudio API is not supported by the browser, the files will be played using HTML5 audio.
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this plugin is available [here](https://www.jspsych.org/latest/plugins/audio-button-response).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.

packages/plugin-audio-keyboard-response/README.md

@@ -0,0 +1,41 @@
+![jspsych logo](http://www.jspsych.org/7.0/img/jspsych-logo.jpg)
+
+jsPsych is a JavaScript framework for creating behavioral experiments that run in a web browser.
+
+## Plugin Description
+
+The audio-keyboard-response plugin plays audio files and records responses generated with the keyboard. The audio will be played using the WebAudio API, allowing for reasonably precise timing of the playback by measuring it against the WebAudio specific clock. If WebAudio API is not supported by the browser, the files will be played using HTML5 audio.
+
+## Examples
+
+Several example experiments and plugin demonstrations are available in the `/examples` folder.
+After you've downloaded the [latest release](https://github.com/jspsych/jsPsych/releases), double-click on an example HTML file to run it in your web browser, and open it with a programming-friendly text editor to see how it works.
+
+## Documentation
+
+Documentation for this plugin is available [here](https://www.jspsych.org/latest/plugins/audio-keyboard-response).
+
+## Getting help
+
+For questions about using the library, please use the GitHub [discussions forum](https://github.com/jspsych/jsPsych/discussions).
+You can also browse through the history of Q&A on the forum to find related questions.
+
+## Contributing
+
+We :heart: contributions!
+See the [contributing to jsPsych](https://www.jspsych.org/latest/developers/contributing/) documentation page for more information about how you can help.
+
+## Citation
+
+If you use this library in academic work, please cite the [paper that describes jsPsych](http://link.springer.com/article/10.3758%2Fs13428-014-0458-y):
+
+de Leeuw, J.R. (2015). jsPsych: A JavaScript library for creating behavioral experiments in a Web browser. _Behavior Research Methods_, _47_(1), 1-12. doi:10.3758/s13428-014-0458-y
+
+## Contributors
+
+jsPsych is open source project with [numerous contributors](https://github.com/jspsych/jsPsych/graphs/contributors).
+The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw](https://github.com/jodeleeuw)), Becky Gilbert ([@becky-gilbert](https://github.com/becky-gilbert)), and Björn Luchterhandt ([@bjoluc](https://github.com/bjoluc)).
+
+jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw).
+
+We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021.