Mercurial > prosody-modules

changeset 3785:6273705e3830

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_nodeinfo2: Add a README
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sun, 29 Dec 2019 22:09:58 +0100
parents 741a1e400de4
children 58e484426d13
files mod_nodeinfo2/README.markdown
diffstat 1 files changed, 34 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_nodeinfo2/README.markdown	Sun Dec 29 22:09:58 2019 +0100
@@ -0,0 +1,34 @@
+---
+description: 
+labels: 'Stage-Alpha'
+---
+
+Introduction
+============
+
+This module exposes a [nodeinfo2](https://git.feneas.org/jaywink/nodeinfo2)
+.well-known URL for use e.g. from
+[the-federation.info](https://the-federation.info).
+
+Configuration
+=============
+
+Enable the `nodeinfo` module in your global `modules_enabled` section:
+```
+modules_enabled = {
+    ...
+    "nodeinfo2"
+    ...
+}
+```
+
+This module depends on [mod\_http](https://prosody.im/doc/http), all of its
+configuration actually happens in this module.
+
+Compatibility
+=============
+
+  ----- -----------
+  trunk Works
+  0.11  Should work
+  ----- -----------