filed

Job queue using FUSE

commit 3e8025f34abad9970c4cfa649f4a49026baeb6a8
parent 2d9f568df1385b6d01731bb776eb29d4e9fd7045
Author: Marc Coquand <marc@coquand.email>
Date:   Sun, 14 Dec 2025 19:51:16 +0100

Docs

Diffstat:
M
README.md
 | 
4
++--
M
qj.1.scd
 | 
9
+++++++--

2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# qj - Queue jobs
+# qj - queue jobs
 
 `qj` is a simple job queue that is manipulated using files. It is intended for single-server workloads and features:
 
@@ -7,7 +7,7 @@
 - Timeout
 - Job limits
 
-Other features are enabled by using built-in Unix features:
+`qj` aims to be a good unix citizen, and works well with other tools in the ecosystem, for example:
 
 - Periodic jobs using cron
 - Access rights using unix users
diff --git a/qj.1.scd b/qj.1.scd
@@ -34,7 +34,8 @@ in the directories correspond to jobs. To create a job, simply add it to
 
 qj exposes 2 files: 
 
-	*new-id* generate a unique id that can be used for job names
+	*new-id* contains a unique id that can be sampled for job name entropy,
+	similar to /dev/urandom
 
 	*config.json* provides settings for max-retries, timeouts, max
 	concurrent jobs.
@@ -51,9 +52,13 @@ Create a new job with $JOBID that echoes hello world:
 
 	$ printf "echo helloworld" >> "/var/qj/pending/$JOBID"
 
-Retry a failing job:
+Retry a failing job titled `E6Xe`:
 
 	$ mv /var/qj/failed/E6Xe /var/qj/pending
 
+Inspect a currently running job titled `E6Xe`
+
+	$ cat /var/qj/active/E6Xe
+
 Periodic jobs can be set up using _CRON(8)_.