# HG changeset patch
# User Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
# Date 1577653798 -3600
# Node ID 6273705e3830d93cc87a20280c2e17d4c4b5fbdc
# Parent  741a1e400de417756e649b60819bfb799627531c
mod_nodeinfo2: Add a README

diff -r 741a1e400de4 -r 6273705e3830 mod_nodeinfo2/README.markdown
--- /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
+  ----- -----------