Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_devices/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,46 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'Device identification'
+...
+
+Description
+============
+
+This is an experimental module that aims to identify the different
+devices (technically clients) that a user uses with their account.
+
+It is expected that at some point this will be backed by a nicer protocol,
+but it currently uses a variety of hacky methods to track devices between
+sessions.
+
+Usage
+=====
+
+``` {.lua}
+modules_enabled = {
+    -- ...
+    "devices",
+    -- ...
+}
+```
+
+Configuration
+=============
+
+Option summary
+--------------
+
+  option                         type                    default
+  ------------------------------ ----------------------- -----------
+  max\_user\_devices             number                  `5`
+
+
+Compatibility
+=============
+
+  ------- -----------------------
+  trunk   Works
+  0.11    Works
+  0.10    Does not work
+  ------- -----------------------