From ee85c047965020af22b447b79163cfbb3abb7b73 Mon Sep 17 00:00:00 2001 From: Ben Parsons Date: Wed, 13 Mar 2019 17:54:46 +0000 Subject: [PATCH 1/2] "Render simple counters in room header" details --- docs/labs.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/labs.md diff --git a/docs/labs.md b/docs/labs.md new file mode 100644 index 0000000000..6c9b801f77 --- /dev/null +++ b/docs/labs.md @@ -0,0 +1,30 @@ +# 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 \ No newline at end of file From d098857d5a7df09af9c75c0960de23179234f253 Mon Sep 17 00:00:00 2001 From: Ben Parsons Date: Fri, 22 Mar 2019 14:49:44 +0000 Subject: [PATCH 2/2] wrap text and link from README.md --- README.md | 6 ++++++ docs/labs.md | 6 ++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6578e55ef2..16f41fcb2b 100644 --- a/README.md +++ b/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 =========== diff --git a/docs/labs.md b/docs/labs.md index 6c9b801f77..65b16edf90 100644 --- a/docs/labs.md +++ b/docs/labs.md @@ -1,8 +1,10 @@ # 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. +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.** +**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