--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_bookmarks/README.markdown Sat Aug 18 13:48:45 2018 +0100
@@ -0,0 +1,33 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: Synchronise bookmarks between Private XML and PEP
+...
+
+Introduction
+------------
+
+This module fetches users’ bookmarks from Private XML and pushes them
+to PEP on login, and then redirects any Private XML query to PEP. This
+allows interop between older clients that use [XEP-0048:
+Bookmarks](https://xmpp.org/extensions/xep-0048.html) in its [1.0
+version](https://xmpp.org/extensions/attic/xep-0048-1.0.html) and
+recent clients which use it in
+[PEP](https://xmpp.org/extensions/xep-0163.html).
+
+Configuration
+-------------
+
+Simply [enable it like most other
+modules](https://prosody.im/doc/installing_modules#prosody-modules), no
+further configuration is needed.
+
+Compatibility
+-------------
+
+ ------- ---------------
+ trunk Works
+ 0.10 Does not work
+ 0.9 Does not work
+ 0.8 Does not work
+ ------- ---------------