From 62bf9cc5a08d524c2acaff22c34ff5c6943e2454 Mon Sep 17 00:00:00 2001
From: Christian Neukirchen <chneukirchen@gmail.com>
Date: Mon, 10 Aug 2015 13:28:18 +0200
Subject: README.md: document assumptions

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

diff --git a/README.md b/README.md
index 364477c..4a3e324 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,15 @@ different queues for different purposes is encouraged.
 All these operations take worst-case quadratic time in the amount of
 lock files produced, so you should clean them regularly.
 
+## Assumptions
+
+`nq` will only work correctly when:
+- `$NQDIR` (respectively `.`) is writable.
+- `flock(2)` works in `$NQDIR` (respectively `.`).
+- `gettimeofday` behaves monotonic (using `CLOCK_MONOTONIC` would
+  create confusing file names).
+- No other programs put files matching `,*` into `$NQDIR` (respectively `.`).
+
 ## nq helpers
 
 Two helper programs are provided:
-- 
cgit 1.4.1