Create a tutorial for the package

coglabuzh / online-exps

Unleash the full potential of JavaScript and supercharge your web experiments with this library for experimental programming - based on jsPsych - work in progress! 🎯

2 stars 0 forks source link

Create a tutorial for the package #12

Closed chenyu-psy closed 9 months ago

chenyu-psy commented 9 months ago

Hello,

Could you please include a tutorial on how to use this package in the readme file? For example, explain how to install it using the npm function and how to install the development version from Github (if possible). If it has not been published yet, could you also provide instructions on how to download a single function and implement it in our own experiment?

ajit283 commented 9 months ago

Hi Chenyu,

I have decided to add everything that is relevant for the library user in README.md, while adding everything related to library development in CONTRIBUTING.md.

Instructions for installing this library from npm are now part of README.md
Instructions for developing locally and using the local version are in CONTRIBUTING.md (in the chapter "Previewing Results").

Let me know if you are fine with this setup!

chenyu-psy commented 9 months ago

Hi Ajit,

Thank you for your work. It makes sense to me. Let's keep doing it until someone has a better suggestion.