filed

Job queue using FUSE

git clone git://mccd.space/filed

commit 7ac464d07861ea82090d36c1eecf508b7f558084
parent 175e737b059959acbdf15e012355753ee2353817
Author: Marc Coquand <marc@coquand.email>
Date:   Mon, 15 Dec 2025 13:41:11 +0100

docs

Diffstat:
MREADME.md | 16++++++----------
1 file changed, 6 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -30,11 +30,7 @@ scdoc < qj.1.scd > qj.1
 
 ## Basic Principles
 
-`qj` is a job queue that operates using files. Each job
-corresponds to one file, and the directories indicate their state
-state. Below are some examples to get you started. See the [man
-pages](https://git.sr.ht/~marcc/qj/tree/main/item/qj.1.scd) for more complete
-documentation
+`qj` is a job queue that operates using files. Each job corresponds to one file, and the directories indicate their state state. Below are some examples to get you started. It is recommended to read the [man pages] for more complete documentation and security considerations.
 
 `qj` requires a job directory and a location for a state file.
 
@@ -57,16 +53,16 @@ If all went well, you can see the job output:
 $ cat /tmp/qj-jobs/complete/1
 ```
 
-By default, a job retries 3 times, and then moved to the `failed` directory. To restart a job after that, move the job back to pending:
+By default, a job retries 3 times, and then moved to the `failed` directory. You can inspect the logs to see what went wrong:
 
 ```
-$ mv /tmp/qj-jobs/failed/1 /tmp/qj-jobs/pending
+$ cat /tmp/qj-jobs/active/1
 ```
 
-### Inspect job logs
+To restart a job after that, move the job back to pending:
 
 ```
-$ cat /tmp/qj-jobs/active/1
+$ mv /tmp/qj-jobs/failed/1 /tmp/qj-jobs/pending
 ```
 
 ## TODO
@@ -85,4 +81,4 @@ $ cat /tmp/qj-jobs/active/1
 [nq]: https://github.com/leahneukirchen/nq
 [task-spooler]: https://github.com/justanhduc/task-spooler
 [bull]: https://www.npmjs.com/package/bull
-
+[man pages]: https://git.sr.ht/~marcc/qj/tree/main/item/qj.1.scd