Mercurial > prosody-modules

diff mod_statistics_statsman/README.markdown @ 3608:2c25594f9e71

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_statistics_statsman/README: Describe how to switch from mod_statistics
author Kim Alvefur <zash@zash.se>
date Tue, 28 May 2019 21:23:35 +0200
parents e995cd0f228e
children bac3dae031ee
line wrap: on
line diff
--- a/mod_statistics_statsman/README.markdown	Tue May 28 21:15:09 2019 +0200
+++ b/mod_statistics_statsman/README.markdown	Tue May 28 21:23:35 2019 +0200
@@ -1,3 +1,15 @@
 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>"`.