Merge pull request #149 from Coehill/patch-1

Improve Readme grammar and clarity

README.md

@@ -1,25 +1,25 @@
 # FediFetcher for Mastodon
 
-This GitHub repository provides a simple script that can pull missing posts into Mastodon using the Mastodon API. FediFetcher has no further dependencies, and can be run as either a GitHub Action, as a scheduled cron job, or a pre-packaged container. Here is what FediFetcher can do:
+This GitHub repository provides a simple script that can pull missing posts into Mastodon using the Mastodon API. FediFetcher has no further dependencies, and can be run as either a GitHub Action, a scheduled cron job, or a pre-packaged container. Here is what FediFetcher can do:
 
 1. It can pull missing remote replies to posts that are already on your server into your server. Specifically, it can
-   1. fetch missing replies to posts that users on your instance have already replied to,
+   1. fetch missing replies to posts that users on your instance have already replied to
-   2. fetch missing replies to the most recent posts in your home timeline,
+   2. fetch missing replies to the most recent posts in your home timeline
-   3. fetch missing replies to your bookmarks,
+   3. fetch missing replies to your bookmarks
-   4. fetch missing replies to your favourites,
+   4. fetch missing replies to your favourites
-   5. fetch missing replies to the most recent posts in your lists.
+   5. fetch missing replies to the most recent posts in your lists
 2. It can also backfill profiles on your instance. In particular it can
-   1. fetch missing posts from users that have recently appeared in your notifications,
+   1. fetch missing posts from users that have recently appeared in your notifications
-   2. fetch missing posts from users that you have recently followed,
+   2. fetch missing posts from users that you have recently followed
-   3. fetch missing posts from users that have recently followed you,
+   3. fetch missing posts from users that have recently followed you
-   4. fetch missing posts from users that have recently sent you a follow request,
+   4. fetch missing posts from users that have recently sent you a follow request
-   5. fetch missing posts from users that have recently been added to your lists.
+   5. fetch missing posts from users that have recently been added to your lists
 
-Each part of this script is fully configurable, and you can completely disable parts that you are not interested in.
+Each part of this script is fully configurable and you can disable parts that you are not interested in.
 
 FediFetcher will store posts and profiles it has already pulled in on disk, to prevent re-fetching the same info in subsequent executions.
 
-**Be aware, that this script may run for a *very* long time.** This is particularly true, the first time this script runs, and/or if you enable all parts of this script. You should ensure that you take steps to prevent multiple overlapping executions of this script, as that will lead to unpleasant results. There are detailed instructions for this below.
+**Be aware, that this script may run for a *very* long time.** This is particularly true for the first time this script runs and/or if you enable all parts of this script. You should ensure that you take steps to prevent multiple overlapping executions of this script, as that will lead to unpleasant results. There are detailed instructions for this below.
 
 For detailed information on the how and why, please read the [FediFetcher for Mastodon page](https://blog.thms.uk/fedifetcher?utm_source=github).
 
@@ -29,10 +29,10 @@ FediFetcher makes use of the Mastodon API. It'll run against any instance implem
 
 FediFetcher will pull in posts and profiles from any servers running the following software: 
 
-- Servers that implement the Mastodon API: Mastodon, Pleroma, Akkoma, Pixelfed, Hometown, Iceshrimp,
+- Servers that implement the Mastodon API: Mastodon, Pleroma, Akkoma, Pixelfed, Hometown, Iceshrimp
-- Servers that implement the Misskey API: Misskey, Calckey, Firefish, Foundkey, Sharkey,
+- Servers that implement the Misskey API: Misskey, Calckey, Firefish, Foundkey, Sharkey
-- Lemmy,
+- Lemmy
-- Peertube.
+- Peertube
 
 ## Setup
 
@@ -70,7 +70,7 @@ Run FediFetcher as a GitHub Action, a cron job, or a container:
 3. Create a file called `config.json` with your [configuration options](#configuration-options) in the repository root. **Do NOT include the Access Token in your `config.json`!**
 4. Finally go to the Actions tab and enable the action. The action should now automatically run approximately once every 10 min.
 
-> **Note**
+> [!NOTE]
 >
 > Keep in mind that [the schedule event can be delayed during periods of high loads of GitHub Actions workflow runs](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule).
 
@@ -85,7 +85,7 @@ If desired, all configuration options can be provided as command line flags, ins
 
 When using a cronjob, we are using file based locking to avoid multiple overlapping executions of the script. The timeout period for the lock can be configured using `lock-hours`.
 
-> **Note**
+> [!TIP]
 >
 > If you are running FediFetcher locally, my recommendation is to run it manually once, before turning on the cron job: The first run will be significantly slower than subsequent runs, and that will help you prevent overlapping during that first run.
 
@@ -96,7 +96,7 @@ FediFetcher is also available in a pre-packaged container, [FediFetcher](https:/
 1. Pull the container from `ghcr.io`, using Docker or your container tool of choice: `docker pull ghcr.io/nanos/fedifetcher:latest`
 2. Run the container, passing the configurations options as command line arguments: `docker run -it ghcr.io/nanos/fedifetcher:latest --access-token=<TOKEN> --server=<SERVER>`
 
-> **Note**
+> [!IMPORTANT]
 >
 > The same rules for running this as a cron job apply to running the container: don't overlap any executions.
 
@@ -114,9 +114,9 @@ See [systemd.md](./examples/systemd.md)
 
 FediFetcher has quite a few configuration options, so here is my quick configuration advice, that should probably work for most people:
 
-> **Warning**
+> [!CAUTION]
 >
-> **Do NOT** include your `access-token` in the `config.json` when running FediFetcher as GitHub Action. When running FediFetcher as GitHub Action **ALWAYS** [set the Access Token as an Action Secret](#to-run-fedifetcher-as-a-github-action).
+> **Remove the `access-token` from the `config.json`** when running FediFetcher as GitHub Action. When running FediFetcher as GitHub Action **ALWAYS** [set the Access Token as an Action Secret](#to-run-fedifetcher-as-a-github-action).
 
 ```json
 {
@@ -190,4 +190,4 @@ This is only supported when running FediFetcher as cron job, or container. Multi
 
 ## Acknowledgments
 
-The original inspiration of this script, as well as parts of its implementation are taken from [Abhinav Sarkar](https://notes.abhinavsarkar.net/2023/mastodon-context). Thank you Abhinav!
+The original inspiration of this script, as well as parts of its implementation were taken from [Abhinav Sarkar](https://notes.abhinavsarkar.net/2023/mastodon-context). Thank you Abhinav!