From d8be9d95e8d6bbfc6407f05f97d4756c517a4621 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@blender.org>
Date: Fri, 17 Jun 2022 11:05:50 +0200
Subject: [PATCH] README: document task status meanings

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

diff --git a/README.md b/README.md
index 6b7df259..904ffbee 100644
--- a/README.md
+++ b/README.md
@@ -138,6 +138,20 @@ tables. Because of this, avoid `NOT NULL` columns, as they will be problematic
 in this process.
 
 
+## Task Statuses
+
+The following table shows the meaning of the different task statuses:
+
++---------------+---------+-----------+
+| Status        | Meaning | Next Status |
++---------------+---------+-----------+
+| `queued`      | Ready to be worked on by a Worker | `active`, `canceled` |
+| `active`      | Assigned to a worker for execution | `completed`, `canceled`, `failed`, `soft-failed` |
+| `soft-failed` | Same as `queued`, but has been failed by a worker in an earlier execution | `completed`, `failed`, `canceled` |
+| `completed`   | Worker executed the task succesfully | `requeued` |
+| `paused`      | Not yet implemented | |
++---------------+---------+-----------+
+
 ## License
 
 Flamenco is licensed under the GPLv3+ license.