Skip to content

Commit

Permalink
more readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dphiffer committed Sep 24, 2024
1 parent 551835c commit 8c8b9fd
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,9 @@ A command-line tool to fetch [Blacklight](https://themarkup.org/series/blackligh
- `npm install`
- `./blacklight-query urls.txt` where `urls.txt` has newline-separated absolute URLs to scan

## You can use pipes

You can also pipe your list of URLs.

- `echo "https://themarkup.org/" | ./blacklight-query`
- `./blacklight-query < urls.txt`

## Inputs

Write all URLs you wish to scan as **absolute URLs** (including protocol, domain, and path) in a file named `urls.txt` in the root directory. Separate urls by newline.
Write all URLs you wish to scan as **absolute URLs** (including protocol, domain, and path). Separate each URL with a newline.

### Sample `urls.txt` file

Expand All @@ -31,6 +24,13 @@ https://www.themarkup.org
https://www.calmatters.org
```

### You can use pipes

You can also pipe your list of URLs.

- `echo "https://themarkup.org/" | ./blacklight-query`
- `./blacklight-query < urls.txt`

### Collector Options

All of the [`blacklight-collector`](https://github.com/the-markup/blacklight-collector?tab=readme-ov-file#collector-configuration) options can be specified using this tool, by editing the `config` object in `main.ts`.
Expand Down

0 comments on commit 8c8b9fd

Please sign in to comment.