Merge pull request #14 from jspsych/reorganization

Reorganization

.changeset/plenty-books-wait.md

@@ -0,0 +1,7 @@
+---
+"@jspsych/new-extension": patch
+"@jspsych/new-timeline": patch
+"@jspsych/new-plugin": patch
+---
+
+This patch adds README for new-extension and new-timeline; fixes new-timeline package name; and fixes note in README for all 3 packages.

packages/new-extension/README.md

@@ -0,0 +1,9 @@
+# `@jspsych/new-extension`
+This package allows you to start building an extension in any directory by simply running `npx @jspsych/new-extension` from the command line.
+
+You will be prompted to enter a name for your extension, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your extension, and an optional link to a `README.md` file for your extension. Your template package containing boilerplate code will then be automatically generated in your current working directory.
+
+> [!NOTE]
+> If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder.
+
+In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your extension, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your extension provides. The file that contains your actual extension code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your extension so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your extension, we highly recommend filling out the `CITATION.cff` file as it allows your extension's users to easily cite your extension.

packages/new-plugin/README.md

@@ -3,7 +3,7 @@ This package allows you to start building a plugin in any directory by simply ru
 
 You will be prompted to enter a name for your plugin, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your plugin, and an optional link to a `README.md` file for your plugin. Your template package containing boilerplate code will then be automatically generated in your current working directory.
 
-!!! note
-    If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder. In general, if you are planning to publish your plugin, we recommend choosing TypeScript as your plugin's language, because________________.
+> [!NOTE]
+> If you are running this command in the jspsych-contrib repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder.
 
 In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your plugin, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your plugin provides. The file that contains your actual plugin code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your plugin so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your plugin, we highly recommend filling out the `CITATION.cff` file as it allows your plugin's users to easily cite your plugin.

packages/new-timeline/README.md

@@ -0,0 +1,9 @@
+# `@jspsych/new-timeline`
+This package allows you to start building a timeline in any directory by simply running `npx @jspsych/new-timeline` from the command line.
+
+You will be prompted to enter a name for your timeline, a description, the name of the author, an optional link to the author's GitHub profile, the preferred language (TypeScript or JavaScript) for your timeline, and an optional link to a `README.md` file for your timeline. Your template package containing boilerplate code will then be automatically generated in your current working directory.
+
+> [!NOTE]
+> If you are running this command in the jspsych-timelines repository, you will not be prompted to enter a `README.md` link. It will be generated automatically, and your template package will also be automatically generated under the `./packages` folder.
+
+In the generated package, you will find a `./docs` folder containing a markdown file for you to fill in technical information about your timeline, e.g. additional parameters it takes in and the data it generates. You will also find an `./examples` folder where you can write simple scripts to demonstrate the functionality your timeline provides. The file that contains your actual timeline code should be the `index.js` file under the `./src` folder. Lastly, we also provide a `package.json` for you to list metadata about your timeline so that it can be easily published to a registry like `npm`, a `README.md` and a `CITATION.cff` file. If you plan to publish your timeline, we highly recommend filling out the `CITATION.cff` file as it allows your timeline's users to easily cite your timeline.

packages/new-timeline/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@jspsych-timelines/new-timeline",
-  "version": "0.2.1",
+  "name": "@jspsych/new-timeline",
+  "version": "0.0.1",
   "description": "CLI tool for creating new jsPsych timelines",
   "type": "module",
   "files": [