From 0f2ea1e310b61e7aa4c9449b6db5aa31c7dd384e Mon Sep 17 00:00:00 2001
From: Axel Boberg <git@axelboberg.se>
Date: Sat, 30 Mar 2024 21:06:27 +0100
Subject: [PATCH] Document ui.readable in the item type spec

Signed-off-by: Axel Boberg <git@axelboberg.se>
---
 docs/api/README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/docs/api/README.md b/docs/api/README.md
index 9f005d3..e7a8c70 100644
--- a/docs/api/README.md
+++ b/docs/api/README.md
@@ -274,7 +274,15 @@ Types are blueprints for items, they can be created and extended using the `cont
           will be shown together in the
           inspector
           */
-          "ui.group": "My plugin"
+          "ui.group": "My plugin",
+
+          /*
+          Set to true to signal that widgets should show this
+          information when presenting the item, such as the rundown
+
+          Defaults to false
+          */
+          "ui.readable": true
         },
 
         /*
@@ -295,7 +303,7 @@ Types are blueprints for items, they can be created and extended using the `cont
           "name": "My second property",
           "type": "string",
           "ui.uri": "/path/to/custom/input"
-        },
+        }
       }
     }
   ]