Merge pull request #9154 from vector-im/benp/labs-docs

"Render simple counters in room header" details

README.md

@@ -256,6 +256,12 @@ To change the config.json for the desktop app, create a config file which will b
 
 In the paths above, `$NAME` is typically `Riot`, unless you use `--profile $PROFILE` in which case it becomes `Riot-$PROFILE`.
 
+Labs Features
+=============
+
+Some features of Riot may be enabled by flags in the `Labs` section of the settings.
+Some of these features are described in [labs.md](/~https://github.com/vector-im/riot-web/blob/develop/docs/labs.md).
+
 Development
 ===========
 

docs/labs.md

@@ -0,0 +1,32 @@
+# riot-web Labs features
+
+Some notes on the features you can enable by going to `Settings->Labs`. Not exhaustive, chat in
+[#riot-web:matrix.org] for more information.
+
+**Be warned! Labs features are not finalised, they may be fragile, they may change, they may be
+dropped. Ask in the room if you are unclear about any details here.**
+
+## Render simple counters in room header
+
+Allows rendering of labelled counters above the message list.
+
+Once enabled, send a custom state event to a room to set values:
+
+1. In a room, type `/devtools` to bring up the devtools interface
+2. Click "Send Custom Event"
+3. Toggle from "Event" to "State Event"
+4. Set the event type to: `re.jki.counter` and give it a unique key
+5. Specify the content in the following format:
+
+```
+{
+    "link": "",
+    "severity": "normal",
+    "title": "my counter",
+    "value": 0
+}
+```
+
+That's it. Now should see your new counter under the header.
+
+[#riot-web:matrix.org]: https://matrix.to/#/#riot-web:matrix.org