From 33901095899e49b32be5a41ffa075c6fea75ca31 Mon Sep 17 00:00:00 2001 From: cchang-vassar <79338042+cchang-vassar@users.noreply.github.com> Date: Fri, 6 Sep 2024 17:45:57 -0400 Subject: [PATCH] fix broken readme links --- README.md | 21 ++++----------------- update-readme.js | 4 ++-- 2 files changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7ab6747..3f7f875 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,17 @@ The `/packages` directory also contains two template sub-folders that can be use + ### Timelines Timeline | Contributor | Description ----------- | ----------- | ----------- -[arrow-flanker](https://github.com/jspsych/jspsych-timelines/blob/main/packages/@jspsych-timelines/arrow-flanker/README.md) | [Josh de Leeuw](https://github.com/jodeleeuw) | Arrow flanker task for jsPsych -[false-memory](https://github.com/jspsych/jspsych-timelines/blob/main/packages/@jspsych-timelines/false-memory/README.md) | [Cherrie Chang](https://github.com/cchang-vassar) | False memory task for jsPsych -[spatial-cueing](https://github.com/jspsych/jspsych-timelines/blob/main/packages/@jspsych-timelines/spatial-cueing/README.md) | [Cherrie Chang](https://github.com/cchang-vassar) | A shareable timeline of the Posner spatial cueing task. +[arrow-flanker](https://github.com/jspsych/jspsych-timelines/blob/main/packages/arrow-flanker/README.md) | [Josh de Leeuw](https://github.com/jodeleeuw) | Arrow flanker task for jsPsych +[false-memory](https://github.com/jspsych/jspsych-timelines/blob/main/packages/false-memory/README.md) | [Cherrie Chang](https://github.com/cchang-vassar) | False memory task for jsPsych +[spatial-cueing](https://github.com/jspsych/jspsych-timelines/blob/main/packages/spatial-cueing/README.md) | [Cherrie Chang](https://github.com/cchang-vassar) | A shareable timeline of the Posner spatial cueing task. ## Using timelines from this repository - - - - - - - - - - - - - - The modules in this repository can be loaded via a CDN or via NPM. The CDN is the easiest way to get started. For example, to load the [arrow-flanker]() timeline from the CDN, you would add the following script tag to your HTML document: ```html diff --git a/update-readme.js b/update-readme.js index b1ba0f8..c540cd4 100644 --- a/update-readme.js +++ b/update-readme.js @@ -41,14 +41,14 @@ function updateRootReadme() { Timeline | Contributor | Description ----------- | ----------- | -----------\n`; - const guidelinesHead = "## Using timelines from this repository\n"; + const guidelinesHead = "## Using timelines from this repository\n\n"; let timelineList = ""; packageInfos.map((info) => { const authorRender = info.authorUrl ? `[${info.author}](${info.authorUrl})` : info.author; const packageName = info.name.replace(/^\@jspsych-timelines\//g, ""); - const packageReadmeLink = `https://github.com/jspsych/jspsych-timelines/blob/main/packages/${packageReadmeLink}/README.md`; + const packageReadmeLink = `https://github.com/jspsych/jspsych-timelines/blob/main/packages/${packageName}/README.md`; timelineList = timelineList.concat( `[${packageName}](${packageReadmeLink}) | ${authorRender} | ${info.description ? info.description : "foo"} \n` );