1
0
Fork 0
mirror of https://github.com/myned/modufur.git synced 2024-11-01 21:02:38 +00:00

Update README

This commit is contained in:
Myned 2022-02-21 04:51:13 -06:00
parent da8ff759e5
commit aecb10d3f2
No known key found for this signature in database
GPG key ID: 33790F979F7A28B8

View file

@ -1,11 +1,11 @@
# Modufur # Modufur
An experimental [Hikari](https://github.com/hikari-py/hikari) Discord bot for reverse image searching using [SauceNAO](https://saucenao.com) & [Kheina](https://kheina.com) An experimental [Hikari](https://www.hikari-py.dev) Discord bot for reverse image searching using [SauceNAO](https://saucenao.com) & [Kheina](https://kheina.com).
## Requirements ## Requirements
[Python](https://www.python.org) 3.10+\ [Python](https://www.python.org) 3.10+\
[Poetry](https://python-poetry.org) [Poetry](https://python-poetry.org)
## Installation ## Installing
``` ```
git clone https://github.com/Myned/Modufur.git git clone -b hikari https://github.com/Myned/Modufur.git
``` ```
``` ```
cd Modufur cd Modufur
@ -17,8 +17,8 @@ poetry install
``` ```
poetry run python run.py poetry run python run.py
``` ```
## Configuration ## Setup
`config.toml` `config.toml` will automatically generate if it does not exist
``` ```
guilds = [] # guild IDs to register commands, empty for global guilds = [] # guild IDs to register commands, empty for global
client = 0 # bot application ID client = 0 # bot application ID
@ -27,6 +27,19 @@ activity = "" # bot status
saucenao = "" # saucenao token saucenao = "" # saucenao token
e621 = "" # e621 token e621 = "" # e621 token
``` ```
## Updating
```
cd Modufur
```
```
git pull
```
```
poetry env remove python
```
```
poetry update
```
## Credits ## Credits
[hikari](https://github.com/hikari-py/hikari)\ [hikari](https://github.com/hikari-py/hikari)\
[hikari-lightbulb](https://github.com/tandemdude/hikari-lightbulb)\ [hikari-lightbulb](https://github.com/tandemdude/hikari-lightbulb)\