From 62378fb8329188acc1607312a1924d0dad639333 Mon Sep 17 00:00:00 2001 From: Victor Engmark <vengmark@linz.govt.nz> Date: Fri, 19 Nov 2021 14:28:41 +1300 Subject: [PATCH] docs: Explain how to test and how to disable testing --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fc54b2..8be21a2 100644 --- a/README.md +++ b/README.md @@ -51,4 +51,10 @@ It only checks the contained items/collections, but not the other parts of the r 1. `git clone https://github.com/stac-utils/stac-node-validator` to clone the repo 2. `cd stac-node-validator` to switch into the new folder created by git 3. `npm install` to install dependencies -4. Run the commands as above, but replace `stac-node-validator` with `node bin/cli.js`, for example `node bin/cli.js /path/to/your/file.json` \ No newline at end of file +4. Run the commands as above, but replace `stac-node-validator` with `node bin/cli.js`, for example `node bin/cli.js /path/to/your/file.json` + +### Test + +Simply run `npm test` in a working [development environment](#development). + +If you want to disable tests for your fork of the repository, simply delete `.github/workflows/test.yaml`.