@m2c2kit/cli 0.3.8 → 0.3.9

package/README.md

@@ -1,72 +1,22 @@
 # @m2c2kit/cli
 
-This package contains a command line interface (CLI) for developing m2c2kit cognitive assessments.
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![CI/CD](https://github.com/m2c2-project/m2c2kit/actions/workflows/ci.yml/badge.svg)](https://github.com/m2c2-project/m2c2kit/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@m2c2kit/cli.svg)](https://www.npmjs.com/package/@m2c2kit/cli)
 
-## Prerequisites
+This package contains the command line interface (CLI) for developing m2c2kit apps.
 
-- [Node.js](https://nodejs.org/en/download) (version >=18; LTS release suggested). **Required**.
-- [Visual Studio Code](https://code.visualstudio.com/download). Recommended.
-- [Google Chrome](https://www.google.com/chrome). Recommended.
-- [Git](https://git-scm.com/downloads). Recommended.
+**m2c2kit** is a library for cross-platform cognitive assessments. Features:
 
-## Creating a cognitive assessment
+- **Mobile first**. Optimized for touch and mobile devices while also usable on desktops.
+- **Portable**. Use on browsers, compile within native apps using web views, or embed in products like Qualtrics. A shared assessment codebase reduces development time and promotes experiment standardization across devices and services.
+- **Rapid iteration**. Quickly develop and test new assessments with the JavaScript-based library and deploy them in studies.
 
-The CLI can quickly scaffold a demo app and serve it on your local machine. The CLI is installed as the command `m2`. The following commands will install the CLI, scaffold a demo app with an assessment (a simple [Stroop](https://en.wikipedia.org/wiki/Stroop_effect) assessment), and serve it on localhost, port 3000:
+## Resources
 
-```
-npm install -g @m2c2kit/cli
-m2 new myapp
-cd myapp
-npm run serve
-```
+---
 
-You can now go to http://localhost:3000 to view the demo app.
-
-<img style="margin-right: 16px;" src=".github/images/m2c2kit-cli.svg" width="600" />
-
-Note: if you execute `npm run build`, it will create a production build in `dist` that is suitable for deploying to a web server. In a production build, all build artifacts (except for `index.html`) will have hashes added to their filenames to promote cache busting upon repeated deployments.
-
-## Visual Studio Code
-
-When creating a project with `m2 new`, the CLI will configure the project for debugging with Visual Studio Code and Chrome. When the app is served locally (`npm run serve`), debugging in Visual Studio Code is available by pressing `F5` or selecting Run, Start Debugging.
-
-<img src=".github/images/m2c2kit-vscode-debugging.gif" />
-
-## Adding more cognitive assessments
-
-m2c2kit has a rich API for writing your own cognitive assessments. In addition, the m2c2kit team has developed cognitive assessments in ready-to-use form, which are available as separate packages (`@m2c2kit/assessment-symbol-search`, `@m2c2kit/assessment-color-dots`, `@m2c2kit/assessment-grid-memory`, `@m2c2kit/assessment-color-shapes`). Once you have scaffolded the demo app, to add additional assessments:
-
-1. Install the package for the assessment. For example, if you scaffolded your app above with `m2 new myapp`, and now you want to add the m2c2kit Symbol Search assessment, execute the following from the `myapp` directory: `npm install @m2c2kit/assessment-symbol-search`.
-2. Update your app's source code to import the Symbol Search assessment. In the file `src/index.ts`, add to the top: `import { SymbolSearch } from '@m2c2kit/assessment-symbol-search';`
-3. Update your app's source code to create and use an instance of Symbol Search. In the file `src/index.ts`, find these lines:
-
-```
-const activity = new Myapp();
-const session = new Session({
-  activities: [activity],
-```
-
-and change to
-
-```
-const activity = new Myapp();
-const ss = new SymbolSearch();
-const session = new Session({
-  activities: [ss, activity],
-```
-
-Now your app will run Symbol Search before it runs the demo assessment (Stroop).
-
-## Configuring cognitive assessments
-
-The assessments built by the m2c2kit team have reasonable default parameters, but assessments are also configurable. For example, the Symbol Search assessment has a default of 5 trials. To increase that to 10, find the code in `src/index.ts` that creates the `SymbolSearch` object and change it to:
-
-```
-const ss = new SymbolSearch({ "number_of_trials": 10 });
-```
-
-A full listing of the parameters for each assessments, and their default values, is available in repository for each assessment.
-
-## License
-
-MIT
+- [Website](https://m2c2-project.github.io/m2c2kit/)
+- [Live Examples](https://m2c2-project.github.io/m2c2kit/docs/category/examples)
+- [Getting Started](https://m2c2-project.github.io/m2c2kit/docs/getting-started)
+- [Interactive Tutorial](https://m2c2-project.github.io/m2c2kit/docs/tutorial-fundamentals/fundamentals)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m2c2kit/cli",
-  "version": "0.3.8",
+  "version": "0.3.9",
   "description": "m2c2kit command line interface",
   "files": [
     "dist/**"
@@ -16,17 +16,17 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@angular-devkit/core": "^16.0.4",
-    "@angular-devkit/schematics": "^16.0.4",
+    "@angular-devkit/core": "^16.1.0",
+    "@angular-devkit/schematics": "^16.1.0",
     "@m2c2kit/schematics": "^0.1.0",
-    "@schematics/angular": "^16.0.4",
-    "@types/inquirer": "^8.2.4",
+    "@schematics/angular": "^16.1.0",
     "ansi-colors": "4.1.3",
     "inquirer": "8.2.4",
     "symbol-observable": "4.0.0",
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
+    "@types/inquirer": "8.2.6",
     "rimraf": "5.0.1",
     "typescript": "5.1.3"
   }