aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAleteoryx <alyx@aleteoryx.me>2024-11-14 16:39:29 -0500
committerAleteoryx <alyx@aleteoryx.me>2024-11-14 16:39:29 -0500
commit51781163e0eb64128a69062090183fa1877be693 (patch)
treea0e05651fda6fe486b923d4a87e2e474b571c20b /README.md
parentd841acfb37d52d89f5b27610754881e3e9e85932 (diff)
downloadrss_dot_php-51781163e0eb64128a69062090183fa1877be693.tar.gz
rss_dot_php-51781163e0eb64128a69062090183fa1877be693.tar.bz2
rss_dot_php-51781163e0eb64128a69062090183fa1877be693.zip
document feed changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1fefd31..0b4eaba 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,11 @@ The following options are supported per-feed:
- `$feeds[feed]["url"]`: **REQUIRED**: The URL of the RSS/Atom feed.
- `$feeds[feed]["home"]`: An optional homepage for the feed. Will be linked under every entry from it.
+- `$feeds[feed]["render_mode"]`: How to display the feed, one of:
+ - `"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]["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.