From ef3a0b28819dfc3972536962783f6222268b8b26 Mon Sep 17 00:00:00 2001 From: Tim Van Baak Date: Sun, 11 Jun 2023 20:31:48 -0700 Subject: [PATCH] Document intake-reddit in README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 14a44c8..a7bc36b 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,19 @@ Supported `env`: - `FEED_URL`: Required. The url of the RSS/Atom feed. - `FEED_TITLE`: Override the feed ``. Item titles are in the format "[feed title]: [item title]". +## intake-reddit + +A feed source that fetches posts from a subreddit. + +Supported `env`: + +- `SUBREDDIT_NAME`: Required. The subreddit name with no `r/` prefix. +- `SUBREDDIT_PAGE`: The listing page to fetch posts from. Defaults to `hot`. Listings that support multiple time ranges can specify as e.g. `top_week`. +- `REQUEST_RETRY`: Attempt count for fetching posts. Retries are done with exponential backoff. +- `FILTER_NSFW`: By default, NSFW posts are included. Set to a truthy value to skip them. +- `TAG_NSFW`: By default, NSFW posts are tagged `nsfw`. Set to an empty string to suppress this. +- `FILTER_SPOILER`: As `FILTER_NSFW` for posts marked as spoilers. +- `TAG_SPOILER`: As `TAG_NSFW` for posts marked as spoilers. +- `MIN_SCORE`: Skip posts with scores below this number. +- `TAGS`: Comma-separated list of tags to add to all items. +- `AUTHOR_BLOCKLIST`: Comma-separated list of usernames. Posts by these users will be skipped.