From 13b13fd91626d0d807fd6fcc5717abdeebae0970 Mon Sep 17 00:00:00 2001 From: Michael Thomas Date: Mon, 13 Mar 2023 13:22:20 +0000 Subject: [PATCH] udpate readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35fc591..b7c5fce 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,18 @@ This GitHub repository provides a GitHub action runs every 10 mins, and has two parts: -1. It can pull remote replies into your instance, using the Mastodon API. That part itself has two parts: +1. It can pull remote replies into your instance, using the Mastodon API. See [Pull missing responses into Mastodon](https://blog.thms.uk/2023/03/pull-missing-responses-into-mastodon?utm_source=github) for details. That part itself has two parts: 1. It gets remote replies to posts that users on your instance have already replied to during the last `REPLY_INTERVAL_IN_HOURS` hours, and adds them to your own server. 2. It gets remote replies to the last `HOME_TIMELINE_LENGTH` posts from your home timeline, and adds them to your own server. -2. It can also backfill posts from the last `MAX_FOLLOWINGS` users that you have followed. +2. It can also backfill posts from the last `MAX_FOLLOWINGS` users that you have followed. See [Pull missing posts from recently followed accounts into Mastodon](https://blog.thms.uk/2023/03/backfill-recently-followed-accounts?utm_source=github) for details. Each part can be disabled completely, and all of the values are configurable. **Be aware, that this script may run for a long time, if these values are too high.** Experiment a bit with what works for you, by starting with fairly small numbers (maybe `HOME_TIMELINE_LENGTH = 200`, `REPLY_INTERVAL_IN_HOURS = 12`) and increase the numbers as you see fit. -**For full context and discussion on why this is needed, read the blog post: [Pull missing responses into Mastodon](https://blog.thms.uk/2023/03/pull-missing-responses-into-mastodon?utm_source=github)** +For full context and discussion on why this is needed, read the following tow blog posts: +[Pull missing responses into Mastodon](https://blog.thms.uk/2023/03/pull-missing-responses-into-mastodon?utm_source=github) +[Pull missing posts from recently followed accounts into Mastodon](https://blog.thms.uk/2023/03/backfill-recently-followed-accounts?utm_source=github) ## Setup