-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add package.json and readme for js template
- Loading branch information
1 parent
0d964f2
commit c9851f8
Showing
3 changed files
with
84 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# {name} | ||
|
||
## Overview | ||
|
||
{description} | ||
|
||
## Loading | ||
|
||
### In browser | ||
|
||
```html | ||
<script src="https://unpkg.com/@jspsych-timelines/{name}"> | ||
``` | ||
### Via NPM | ||
``` | ||
npm install @jspsych-timelines/{name} | ||
``` | ||
```js | ||
import { createTimeline, timelineUnits, utils } from "@jspsych-timelines/{name}" | ||
``` | ||
## Compatibility | ||
`@jspsych-timelines/{name}` requires jsPsych v7.0.0 or later. | ||
## Documentation | ||
### createTimeline | ||
#### {globalName}.createTimeline(jsPsych, { *options* }) ⇒ <code>timeline</code> | ||
Description of the timeline that this plugin generates | ||
The following parameters can be specified in the **options** parameter. | ||
| Parameter | Type | Default | Description | | ||
|-----------|------|---------|-------------| | ||
| parameter | type | default | description | | ||
### timelineUnits | ||
### utils | ||
## Author / Citation | ||
{author} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
{ | ||
"name": "@jspsych-timelines/{name}", | ||
"version": "0.0.1", | ||
"description": "{description}", | ||
"unpkg": "dist/index.browser.min.js", | ||
"files": [ | ||
"index.js", | ||
"dist" | ||
], | ||
"scripts": { | ||
"build": "babel index.js --presets @babel/preset-env,minify --source-maps --out-file dist/index.browser.min.js", | ||
"build:watch": "npm run build -- --watch" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/jspsych/jspsych-timelines.git", | ||
"directory": "packages/{name}" | ||
}, | ||
"author": { | ||
"name": "{author}", | ||
"url": "{authorUrl}" | ||
}, | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/jspsych/jspsych-timelines/issues" | ||
}, | ||
"homepage": "https://github.com/jspsych/jspsych-timelines/tree/main/packages/{name}", | ||
"devDependencies": { | ||
"@jspsych/config": "^2.0.0", | ||
"jspsych": "^7.0.0" | ||
} | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters