From 9688645864232e8efdfb2c67b7dba629363a1946 Mon Sep 17 00:00:00 2001 From: Holly Date: Mon, 15 Apr 2024 17:44:44 +0000 Subject: [PATCH] Update readme with config instructions, move images around --- README.md | 5 +++-- .../example-garruk.png | Bin .../example-lotus.png | Bin 3 files changed, 3 insertions(+), 2 deletions(-) rename example-garruk.png => readme-assets/example-garruk.png (100%) rename example-lotus.png => readme-assets/example-lotus.png (100%) diff --git a/README.md b/README.md index 16ff042..796866f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ To use, mention the bot with a message that contains at least one Magic card nam See it in action [here](https://botsin.space/@mtgcardlookup)! -![](example-lotus.png) +![](readme-assets/example-lotus.png) ## Features @@ -19,12 +19,13 @@ See it in action [here](https://botsin.space/@mtgcardlookup)! - Includes pinned status management (see "Installation and Setup") - Unpins all current statuses, then posts a pre-written thread and pins each new status in reverse order -![](example-garruk.png) +![](readme-assets/example-garruk.png) ## Installation and Setup - Clone this repository and create a python environment however you like to - Install dependencies with `pip install -r requirements.txt` +- Obtain a `client_key`, `client_secret` and `access_token` for the API for the instance you'll be running the bot on. Copy `config.sample.py` to `config.py` and include those values. Set the instance as well, if it's not https://botsin.space. - Install and enable the included mtgcardlookup.service with systemd, replacing the `ExecStart`, `WorkingDirectory`, and `User` values with those for your system - [OPTIONAL] Write an introduction thread to be pinned - Create a new file called pinned_thread.txt diff --git a/example-garruk.png b/readme-assets/example-garruk.png similarity index 100% rename from example-garruk.png rename to readme-assets/example-garruk.png diff --git a/example-lotus.png b/readme-assets/example-lotus.png similarity index 100% rename from example-lotus.png rename to readme-assets/example-lotus.png