From bfc3d953a0e30c69c03798155d12e1a86320ea8e Mon Sep 17 00:00:00 2001 From: Heiner Tholen Date: Sun, 27 Nov 2022 19:53:12 +0100 Subject: [PATCH] readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d72824..74d75d6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ # HackerNews -> Mastodon Bridge -This repo contains a dockerfile that'll create an image that consumes the HackerNews RSS feed and posts it to mastodon@pub.solar +This repo contains config to consume the HackerNews RSS feed (https://news.ycombinator.com/rss) and to toot the messages to https://mastodon.pub.solar/@hackernews_bot, a mastodon bot. + +The dockerfile builds a container that uses [feed2toot](https://feed2toot.readthedocs.io/en/latest/use.html). All stateful data is expected to be mounted under `/data`, namely: + +* `feed2toot.ini`: config file in this repo +* `feed2toot_clientcred.txt`: from `register_feed2toot_app` script +* `feed2toot_usercred.txt`: from `register_feed2toot_app` script +* `feed2toot_cache.db`: cache file to register previous posts