Diff

mod_statistics_statsman/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 4595:bac3dae031ee
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_statistics_statsman/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,27 @@
+A module providing a streaming statistics interface like
+[mod_statistics] but based on the new [statistics API][doc:statistics]
+introduced in Prosody 0.10.
+
+# Usage
+
+To use, enable the built-in statistics like so:
+
+```lua
+statistics = "internal"
+```
+
+Then, in `modules_enabled`, replace `"statistics"` with
+`"statistics_statsman"` and the various `"statistics_<something>"`
+with equivalent `"measure_<something>"`.
+
+
+# Compatibility
+
+  ------- --------------------
+  trunk   Does not work [^1]
+  0.11    Should work
+  0.10    Should work
+  ------- --------------------
+
+[^1]: not after
+    [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)