From bca9aee838833f35978da2f3caa7e865c9269511 Mon Sep 17 00:00:00 2001
From: dotnet <admin@dotnet00.dev>
Date: Tue, 10 Oct 2023 14:45:09 -0400
Subject: [PATCH] Update readme.

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 5ba41db..dedf04d 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,16 @@ Simple python bot which scrapes images from gelbooru based on specified tags eve
 - Attempts to renote the original source if possible.
 - Option for posting to hashtags (limits to once per day to avoid drowning out other content).
 
+## Installation
+
+Edit the misskeybot.service file with your install path, copy misskeybot.service and misskeybot.timer to `/etc/systemd/system/` then run as root:
+
+```bash
+systemctl daemon-reload                 #Reload unit files
+systemctl enable misskeybot.timer       #Enable the periodic execution of the script
+systemctl start misskeybot.timer        #Start the periodic execution of the script
+```
+
 ## Usage
 
 ```bash
@@ -19,6 +29,7 @@ Usage: python3 gelbooru-bot.py [--gen-config] [--help]
   Note: The values in defaults.json will be used if the values are not set in config.json
 ```
 
+
 ## Files
 ### config.json
 
@@ -40,12 +51,18 @@ Usage: python3 gelbooru-bot.py [--gen-config] [--help]
         "bot_hashtags": "#kancolle",
         "misskey_token": "HHkkuuuutdtdrrrrvWvW8888yayaaaaa",
         "max_page_number": 200,
+        "misskey_url": "https://misskey.io/api/",
         "last_run_time": 1696896202.1551812
     }
 }
 ```
 
 
+- `max_page_number:` Automatically determined by the script.
+
+- `last_run_time:` Used to allow the different bots to post at different times by tracking the last time that specific bot posted.
+
+
 ### defaults.json
 
 ```json
@@ -58,3 +75,5 @@ Usage: python3 gelbooru-bot.py [--gen-config] [--help]
     "max_page_number": 1000
 }
 ```
+
+ - These values are used if not defined in the `config.json`, useful if all bots are on the same url.
\ No newline at end of file