diff options
| author | Caroline Larimore <caroline@larimo.re> | 2025-01-22 00:48:40 -0800 |
|---|---|---|
| committer | Caroline Larimore <caroline@larimo.re> | 2025-01-22 00:48:40 -0800 |
| commit | bb4239f59da123a1b13146955de70055e301a07d (patch) | |
| tree | 2029a7ac8a0637a7cfe3791b93a81a5030cb6f09 | |
| parent | 623aecb436ddd1a5746ed712a64fef23462a317f (diff) | |
Add usage "guide"
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -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 |