Diff

--- a/mod_webpresence/README.markdown	Thu May 18 21:11:13 2023 +0200
+++ b/mod_webpresence/README.markdown	Tue May 23 23:45:00 2023 +0700
@@ -2,65 +2,80 @@
 labels:
 - 'Stage-Stable'
 summary: Display your online status in web pages
+rockspec:
+  build:
+    copy_directories:
+    - icons
 ...
 
 Introduction
 ============
 
 Quite often you may want to publish your Jabber status to your blog or
-website. mod\_webpresence allows you to do exactly this.
-
-Details
-=======
-
-This module uses Prosody's built-in HTTP server (it does not depend on
-mod\_httpserver). It supplies a status icon representative of a user's
-online state.
+website. mod\_webpresence allows you to do exactly this via adhoc control.
 
 Installation
 ============
 
-Simply copy mod\_webpresence.lua to your modules directory, the image
-files are embedded within it. Then add "webpresence" to your
-modules\_enabled list.
+Copy mod\_webpresence.lua to your modules directory then add it to your
+modules\_enabled list:
+
+```
 
-Usage
-=====
+    modules_enabled = {
+        "webpresence";
+    };
+
+```
+
+Configuration & Usage
+=====================
+
+There is a set of icons supplied with the module. But you can configure it to
+load your own in the config file:
 
-Once loaded you can embed the icon into a page using a simple `<img>`
-tag, as follows:
+```
+
+    webpresence_icons = "/path/to/your/icons";    
 
-    <img src="http://prosody.example.com:5280/status/john.smith" />
+```
+
+Beware that the icon files must have the same names as the default files.
+
+This module will always returns offline until you enable it via adhoc.
 
-Alternatively, it can be used to get status name as plaint text, status
-message as plain text or html-code for embedding on web-pages.
+You can embed the icon into a page using a simple `<img>` tag, as follows:
+
+    <img src="http://prosody.example.com:5280/status/john.smith@domain.net" />
 
-To get status name in plain text you can use something like that link:
-`http://prosody.example.com:5280/status/john.smith/text`
+Alternatively, it can be used to get status name as plain text, status message
+as plain text or html-code for embedding on web-pages.
+
+To get status name in plain text you can use something like this link:
+`http://prosody.example.com:5280/status/john.smith@domain.net/text`
 
 To get status message as plain text you can use something like following
-link: `http://prosody.example.com:5280/status/john.smith/message`
+link: `http://prosody.example.com:5280/status/john.smith@domain.net/message`
 
-To get html code, containig status name, status image and status message
-(if set): `http://prosody.example.com:5280/status/john.smith/html`
-
-All other
+To get html code, containing status name, status image and status message
+(if set): `http://prosody.example.com:5280/status/john.smith@domain.net/html`
 
 Compatibility
 =============
 
-  ----- -------
-  trunk   Works
-  0.10   Works
-  0.9   Works
-  0.8   Works
-  0.7   Works
-  0.6   Works
-  ----- -------
+  -----     -------
+  trunk     Works
+  0.12.3    Works
+  0.10      Works
+  0.9       Works
+  0.8       Works
+  0.7       Works
+  0.6       Works
+  -----     -------
 
 Todo
 ====
 
 -   Display PEP information (maybe a new plugin?)
--   More (free) iconsets
 -   Internal/external image generator (GD, ImageMagick)
+-   Display the correct boolean in the first form.