udpate readme

This commit is contained in:
Michael Thomas 2023-03-13 13:22:20 +00:00
parent 022a01f3e8
commit 13b13fd916

View file

@ -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