Add simple readme

This commit is contained in:
2025-06-28 15:48:28 -04:00
parent 91d8efe5bb
commit e3b018b046

12
readme.md Normal file
View File

@@ -0,0 +1,12 @@
# Scraper Web API
This is a dumb little tool which ingests raw HTML files, does some parsing on them, and serves the results over a web API.
```bash
export URL_BASE="http://scraper.homelab.hak8or.com:8080"; \
echo run0 && http POST "$URL_BASE/page/parse/ssd" && \
echo run1 && http POST "$URL_BASE/listing/parse" && \
echo run2 && http GET "$URL_BASE/listing/since/12345678/2" && \
echo run3 && http GET "$URL_BASE/listing/388484391867" && \
echo run4 && http GET "$URL_BASE/listing/286605201240/history"
```