From e3b018b0461f47e4f81ac9a60f8a93d744c23633 Mon Sep 17 00:00:00 2001
From: hak8or <hak8or@gmail.com>
Date: Sat, 28 Jun 2025 15:48:28 -0400
Subject: [PATCH] Add simple readme

---
 readme.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5018f14
--- /dev/null
+++ b/readme.md
@@ -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"
+```