Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readmestage #21

Merged
merged 2 commits into from
Aug 2, 2024
+12 −3
Merged

Readmestage #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
017d92f
Updating readmes with new links
vzhang03 Aug 2, 2024
d091305
Commiting changeset
vzhang03 Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/plenty-dolls-shake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@jspsych/metadata": patch
"@jspsych/metadata-cli": patch
---

Updating READMEs with new links
3 changes: 2 additions & 1 deletion dev/metadata-timeline-variables.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

<script src="https://unpkg.com/@jspsych/plugin-image-keyboard-response@2.0.0" type="text/javascript"></script>
<script src="https://unpkg.com/@jspsych/plugin-preload@2.0.0"></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
View file
Open in desktop
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
View file
Open in desktop
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