# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1490190941 -3600
# Node ID 33f7ca7bdc86998f68be1bf7f5961b5cb9216e28
# Parent  39c39844cd4ca9ec735c78d88ee10913a8b09968
mod_list_active: Add README

diff -r 39c39844cd4c -r 33f7ca7bdc86 mod_list_active/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_list_active/README.markdown	Wed Mar 22 14:55:41 2017 +0100
@@ -0,0 +1,34 @@
+Description
+===========
+
+This module lists those users, who **have** used their account in a
+defined time-frame, basically the inverse of [mod_list_inactive].
+
+Dependencies
+============
+
+[mod_lastlog] must be enabled to collect the data used by this module.
+
+Usage
+=====
+
+    prosodyctl mod_list_active example.com time [format]
+
+Time is a number followed by 'day', 'week', 'month' or 'year'
+
+Formats are:
+
+  --------- ------------------------------------------------
+  default   `user@example.com`
+  event     `user@example.com last action`
+  --------- ------------------------------------------------
+
+Example
+=======
+
+    prosodyctl mod_list_active example.com 1year
+
+Help
+====
+
+    prosodyctl mod_list_active