Skip to content

Commit

Permalink
👌 IMPROVE: info
Browse files Browse the repository at this point in the history
  • Loading branch information
TechWiz-3 committed Jul 31, 2022
1 parent ba9125a commit c7d3a7a
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
Expand Down

0 comments on commit c7d3a7a

Please sign in to comment.