Skip to content

Commit

Permalink
Updating readmes with new links
Browse files Browse the repository at this point in the history
  • Loading branch information
vzhang03 committed Aug 2, 2024
1 parent dfd6463 commit 017d92f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
3 changes: 2 additions & 1 deletion dev/metadata-timeline-variables.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

<script src="https://unpkg.com/@jspsych/[email protected]" type="text/javascript"></script>
<script src="https://unpkg.com/@jspsych/[email protected]"></script>
<script src="../packages/metadata/dist/index.iife.js"></script>
<!-- <script src="../packages/metadata/dist/index.iife.js"></script> -->
<script src="https://unpkg.com/@jspsych/metadata/dist/index.iife.js"></script>
</head>
<body></body>
<script>
Expand Down
4 changes: 3 additions & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ The metadata-cli module contains commands for interacting with the metadata-modu

## CLI with prompting (recommended)

To run the CLI with prompting you can call ```npx jspsych-metadata-cli```. You can also run it through the repository by following the steps 1-3 below and then calling ```npm run build``` followed by ```npx .```.
To run the CLI with prompting you can call ```npm i @jspsych/metadata-cli```. This is the recommended way of running the package.

This will then prompt you through the various CLI options, this includes generating from scratch or using an existing file. There are descriptions of how the files and directories should be structured below.

You can also run it through the repository by following the steps 1-3 below and then calling ```npm run build``` followed by ```npx .```.

## CLI without prompting

Depending on the build step, when running it locally you may need to rename the package.json attribute ```"type": "commonjs"``` to ```"type": "module"```. To run the CLI without prompting, you would need to clone this repo and navigate to the CLI directory. To do this, you must have node installed and it is not recommended unless you have programming experience.
Expand Down
2 changes: 1 addition & 1 deletion packages/metadata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The metadata module contains functions for interacting metadata according to [Ps
You can import the metadata module by including this line at the top of your html.

```html
<script>update</script>
<script src="https://unpkg.com/@jspsych/metadata/dist/index.iife.js"></script>
```

---
Expand Down

0 comments on commit 017d92f

Please sign in to comment.