From bb4239f59da123a1b13146955de70055e301a07d Mon Sep 17 00:00:00 2001
From: Caroline Larimore <caroline@larimo.re>
Date: Wed, 22 Jan 2025 00:48:40 -0800
Subject: Add usage "guide"

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 8d0c22f..0fc9f96 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # status
 
 Just something I threw together real quick for an incredibly specific and niche use case (displaying silly little messages on my girlfriend's dashboard)
+
+## Usage
+- Create `~/.status/auth`
+- Run the server
+- Make requests to `/generate-hash` to create user and admin hashes
+    - With cURL: `curl -u username:password <address>/generate-hash`
+- Put generated hashes into `~/.status/auth`
+- Restart the server
+- Set a message
+    - With cURL: `curl -u username:password -d 'message' -X POST <address>/update`
+- Read the message
+    - With cURL: `curl -u username:password <address>`
+
+If that seems incredibly janky, that's because it is :3
-- 
cgit v1.2.3