From c7d3a7ac6468c428d1cfc9e035e34d94584d82b6 Mon Sep 17 00:00:00 2001 From: TechWiz-3 Date: Sun, 31 Jul 2022 15:24:58 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=91=8C=20IMPROVE:=20info?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c2c80e4..764ec47 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ jobs: - uses: actions/checkout@v2 - name: Run linksafe uses: TechWiz-3/linksafe@main - with: - dirs: "./src,./src/subdir,./doc/website,./doc/more" + with: # comma seperated lists + dirs: ".,./src,./src/subdir,./doc/website,./doc/more" verbose: true whitelist_links: "https://xyz.xyz" whitelist_files: "./doc/HACKING.md" @@ -28,9 +28,11 @@ jobs: `https://example.com` and `http://localhost` are automatically ignored -Each directory to be scanned must be specified directly, otherwise only the root dir will be scanned and subdirs will be ignored. +Each directory to be scanned must be specified directly, otherwise only the root dir will be scanned and subdirs will be ignored. At the same time, if you want the root dir AND subdirs to be scanned, remember to include a `.` as part of the list. -Files and or links can be whitelist i.e. ignore +Files and or links can be whitelisted i.e. ignored. + +Please note, with repos with a lot of links, a scan can take a LONG time, even up to 40+ minutes. ## Todo - [ ] Recognition of remove yt videos