changeset 4874:b7222636bf26

mod_pubsub_summary: Add stub documentation
author Kim Alvefur <zash@zash.se>
date Tue, 18 Jan 2022 09:34:10 +0100
parents 541b2cf68e93
children c8a7cb6fa1a7
files mod_pubsub_summary/README.md
diffstat 1 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pubsub_summary/README.md	Tue Jan 18 09:34:10 2022 +0100
@@ -0,0 +1,13 @@
+Module that generates a nicer text version of Atom feeds, meant for
+use with [mod_pubsub_feeds] and [mod_pubsub_text_interface].
+
+It extracts title, content and links from entries and formats a text
+version like this:
+
+> \***Example Post Title**\*
+>
+> Lorem ipsum dolor sit amet.
+>
+> htts://blog.example.com/example-post
+
+