Skip to content

Commit

Permalink
Merge pull request #13 from the-markup/edits
Browse files Browse the repository at this point in the history
Edits
  • Loading branch information
BatMiles authored Oct 15, 2024
2 parents 7202a11 + baa7fd9 commit 690bf50
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
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 @@ -52,6 +52,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`

0 comments on commit 690bf50

Please sign in to comment.