From 59d4f73181e414d4b72d3d5bff5bd2268b4821ab Mon Sep 17 00:00:00 2001 From: Paul Jickling Date: Tue, 31 Dec 2019 19:30:51 -0500 Subject: [PATCH] Clarified that the route variable needs to be adjusted --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73178c5..f83caff 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,8 @@ A tool for identifying dead links on a web application written in Node (using Pu ## Running Dead Links Search -To run the dead links search tool install puppeteer in your web app directory `npm i puppeteer`, and add the `get_links.js` and `status.sh` files to your project. Run `bash status.sh` and it will generate a file called `status.csv` that you can browse for dead links identified on your web project. +To run the dead links search tool install puppeteer in your web app directory `npm i puppeteer`, and add the `get_links.js` and `status.sh` files to your project. + +You will need to change the `route` variable in the `get_links.js` file if you are not testing locally, or you are using a different port than `3000`. + +Run `bash status.sh` and it will generate a file called `status.csv` that you can browse for dead links identified on your web project.