aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCaroline Larimore <caroline@larimo.re>2025-01-22 00:48:40 -0800
committerCaroline Larimore <caroline@larimo.re>2025-01-22 00:48:40 -0800
commitbb4239f59da123a1b13146955de70055e301a07d (patch)
tree2029a7ac8a0637a7cfe3791b93a81a5030cb6f09 /README.md
parent623aecb436ddd1a5746ed712a64fef23462a317f (diff)
Add usage "guide"
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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