# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1464691559 -3600
# Node ID 287f37e6b6e1fa9e36141fcb09611e78b35954cb
# Parent  a100f4a720cb8c220e8836c816e775ae19fb6434
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)

diff -r a100f4a720cb -r 287f37e6b6e1 mod_list_inactive/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_list_inactive/README.md	Tue May 31 11:45:59 2016 +0100
@@ -0,0 +1,31 @@
+Description
+===========
+
+This module lists those users, who haven't used their account in a defined time-frame.
+
+Dependencies
+============
+
+[mod_lastlog](https://modules.prosody.im/mod_lastlog.html)
+
+Usage
+=====
+
+`prosodyctl mod_list_inactive example.com time [format]`
+
+time is a number followed by 'day', 'week', 'month' or 'year'
+
+formats are:
+delete  user:delete"user@example.com" -- last action
+default user@example.com
+event   user@example.com last action
+
+Example
+=======
+
+`prosodyctl mod_list_inactive example.com 1year`
+
+Help
+====
+
+`prosodyctl mod_list_inactive`