From cac8ef52bdca817f303d4905c933bdccf3920c6b Mon Sep 17 00:00:00 2001
From: Marc Dumais <marc.dumais@ericsson.com>
Date: Wed, 28 Feb 2024 15:34:49 -0500
Subject: [PATCH] update to node 18

Fixes #263

Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
---
 .github/workflows/ci-cd.yml                  | 16 +++++++-------
 .github/workflows/license-check-workflow.yml |  4 ++--
 README.md                                    | 22 ++++++++++++++++++++
 3 files changed, 32 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
index a0a67fb..d22f91e 100644
--- a/.github/workflows/ci-cd.yml
+++ b/.github/workflows/ci-cd.yml
@@ -17,17 +17,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04]
-        node: [16]
+        os: [ubuntu-latest]
+        node: [18]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           registry-url: 'https://registry.npmjs.org'
@@ -55,16 +55,16 @@ jobs:
 
     strategy:
       matrix:
-        node: [16]
+        node: [18]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           registry-url: 'https://registry.npmjs.org'
@@ -78,7 +78,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # https://github.com/microsoft/vscode-ripgrep/issues/9
 
       - name: Publish
-        uses: nick-invision/retry@v2
+        uses: nick-invision/retry@v3
         with:
           timeout_minutes: 5
           retry_wait_seconds: 60
diff --git a/.github/workflows/license-check-workflow.yml b/.github/workflows/license-check-workflow.yml
index da95658..b79f9f6 100644
--- a/.github/workflows/license-check-workflow.yml
+++ b/.github/workflows/license-check-workflow.yml
@@ -28,12 +28,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 2
 
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 
diff --git a/README.md b/README.md
index eb5a62f..f761e8b 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,28 @@
 
 A time graph / gantt chart library for large data (e.g. traces)
 
+## Prerequisites
+
+First, you need Node.js and yarn:
+
+It's suggested to install [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) to manage node on your machine. Once that's done, install the required version:
+
+```bash
+   nvm install 18
+   # optional: make it the default version
+   nvm alias default
+   # or set it every time like so
+   nvm use 18
+```
+
+Then install `yarn`:
+
+```bash
+npm i -g yarn  # the default version should be ok
+```
+
+# Build
+
 To build, from the root type `yarn`
 
 To test an application type `yarn start` then open localhost:8080 on your web browser