mod_atom: Add a brief README
authorKim Alvefur <zash@zash.se>
Fri, 24 Aug 2018 16:16:30 +0200
changeset 3261 f09d92579158
parent 3260 0992c0398783
child 3262 85e3117b2b60
mod_atom: Add a brief README
mod_atom/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_atom/README.markdown	Fri Aug 24 16:16:30 2018 +0200
@@ -0,0 +1,12 @@
+# Introduction
+
+This module exposes users [microblogging][xep277] on Prosodys built-in HTTP server.
+
+# Configuration
+
+The module itself has no options. However it uses the access control
+mechanisms in PubSub, so users must reconfigure their microblogging node
+to allow access, by setting `access_model` to `open`.
+E.g. Gajim has UI for this, look for "Personal Events" → "Configure
+services".
+