Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edits #13

Merged
merged 2 commits into from
Oct 15, 2024
Merged

Edits #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
419c557
spellcheck 'Prerequisites'
BatMiles Sep 11, 2024
baa7fd9
adding note
BatMiles Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A command-line tool to fetch [Blacklight](https://themarkup.org/series/blacklight) scans for a list of urls. Directly queries the open-source [Blacklight Collector](https://github.com/the-markup/blacklight-collector) tool and runs entirely locally.

## Prerequesites
## Prerequisites

- [`nvm`](https://www.linode.com/docs/guides/how-to-install-use-node-version-manager-nvm/)
- [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
Expand Down Expand Up @@ -46,6 +46,10 @@ Read the [`blacklight-collector` README](https://github.com/the-markup/blackligh

All scans will be saved in the `outputs` folder, in subdirectories named for the hostname of the url being scanned.

## Notes

Be aware that the Collector is fairly resource-heavy, and may slow down your computer. We recommend scanning smaller lists if hardware becomes overtaxed.

## Testing

`npm run test`
Loading