Update readme with config instructions, move images around

This commit is contained in:
Holly 2024-04-15 17:44:44 +00:00
parent 9aa8056859
commit 9688645864
3 changed files with 3 additions and 2 deletions

View File

@ -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)! See it in action [here](https://botsin.space/@mtgcardlookup)!
![](example-lotus.png) ![](readme-assets/example-lotus.png)
## Features ## Features
@ -19,12 +19,13 @@ See it in action [here](https://botsin.space/@mtgcardlookup)!
- Includes pinned status management (see "Installation and Setup") - 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 - 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 ## Installation and Setup
- Clone this repository and create a python environment however you like to - Clone this repository and create a python environment however you like to
- Install dependencies with `pip install -r requirements.txt` - 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 - 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 - [OPTIONAL] Write an introduction thread to be pinned
- Create a new file called pinned_thread.txt - Create a new file called pinned_thread.txt

View File

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 222 KiB

View File

Before

Width:  |  Height:  |  Size: 402 KiB

After

Width:  |  Height:  |  Size: 402 KiB