From c1f5fe65089d0b3053c3e5adf944a8acd42c04dd Mon Sep 17 00:00:00 2001
From: Aleteoryx <alyx@aleteoryx.me>
Date: Thu, 14 Nov 2024 20:46:41 -0500
Subject: update readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e0328d3..7f1f175 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # rss_dot_php
 
-A minimal configurable RSS/Atom reader in about 200 lines of PHP.
+A minimal configurable RSS/Atom reader in about 400 lines of PHP.
 
 This tool isn't intended for standalone reading, instead it's
 intended to be used as an aggregator for personal feeds, that can be
@@ -22,6 +22,7 @@ The following options are supported per-feed:
     - `"title"`: The default. Shows the title as a link to the article.
     - `"content"`: Shows the title and content.
     - `"no_title"`: Hides the title, displays the content. A link to the source is put at the bottom.
+- `$feeds[feed]["media"]`: Whether or not to render media files in the feed. Boolean. Defaults to true.
 - `$feeds[feed]["allow_html"]`: Whether or not to allow html in the content area, stripped. Boolean. Defaults to true.
 - `$feeds[feed]["ttl"]`: How long to cache the feed for, in seconds. Defaults to 1 hour.
 - `$feeds[feed]["linkrel"]`: For Atom, which `rel=` value to prefer when getting a link. Defaults to alternate.
@@ -40,6 +41,43 @@ URLs overlap.
 
 [`aleteoryx.css`][css] contains an example stylesheet.
 
+The HTML tree looks like this:
+
+```html
+<main>
+  <!-- if $feeds[feed]["mode"] is "no_title" -->
+  <article data-source="<!-- the key in $feeds this post comes from -->">
+    <div class="rss-content">
+      <div><!-- text content of the entry --></div>
+    </div>
+    <span class="rss-source">
+      <a href="<!-- $feeds[feed]['home'] -->">
+        <!-- the key in $feeds this post comes from -->
+      </a>
+    </span>
+    •
+    <a href="<!-- post URL -->">Source</a>
+    •
+    <time datetime="<!-- post date -->"><!-- post date --></time>
+  </article>
+
+  <!-- otherwise -->
+  <article data-source="<!-- the key in $feeds this post comes from -->">
+    <div class="rss-content">
+      <h1 class="rss-title"><a href="<!-- post URL -->"><!-- post title --></a></h1>
+      <div><!-- text content of the entry, if set to render --></div>
+    </div>
+    <span class="rss-source">
+      <a href="<!-- $feeds[feed]['home'] -->">
+        <!-- the key in $feeds this post comes from -->
+      </a>
+    </span>
+    •
+    <time datetime="<!-- post date -->"><!-- post date --></time>
+  </article>
+</main>
+```
+
 [me]: https://aleteoryx.me
 [php]: https://git.aleteoryx.me/cgit/rss_dot_php/tree/rss.php
 [css]: https://git.aleteoryx.me/cgit/rss_dot_php/tree/aleteoryx.css
-- 
cgit v1.2.3-54-g00ecf