From ba76de34f56806477814b5713597c3d3bbe6544c Mon Sep 17 00:00:00 2001
From: Sean McArdle <sean@mcardletech.com>
Date: Wed, 22 Nov 2023 14:15:21 -0800
Subject: [PATCH] Added readme. Good for me.

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

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1e2d984
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,18 @@
+# httpq
+Dumb simple http message queue for passing values between scripts. It's very useful but will currently let you shoot your foot off. There's no queue size limits, no retry after, probably a bug in the locking, but it does mostly work.
+
+Queues are named by the path: `/<queue name>`. Content is the text body of a POST. A GET against the same path will return the messages in order. GET requests against `/` return queue stats:
+```
+Total queues: 2
+Counts: {"bar": 0, "foo": 12}
+```
+
+It listens on port 8000 by default. This can be changed with an environment variable:
+```
+$ ROCKET_PORT=8888 ./httpq
+
+PS>  $env:ROCKET_PORT=8888; .\httpq.exe
+
+cmd> set ROCKET_PORT=8888
+cmd> .\httpq.exe
+```