docs: add README
This commit is contained in:
parent
0d8fca16a8
commit
a290944708
2 changed files with 28 additions and 0 deletions
6
.idea/vcs.xml
Normal file
6
.idea/vcs.xml
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
22
README.md
Normal file
22
README.md
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
# Maple
|
||||||
|
|
||||||
|
Discord bot for weeb servers; currently this is specifically made for *my own* server,
|
||||||
|
so don't expect many configuration options. If you really want to use it and don't know how
|
||||||
|
to get around, feel free to ask me on fedi `hernik@kitsunes.club` or discord `@hernik`.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Fetch manga info from MangaDex when a user sends a message containing `<Manga Name>`
|
||||||
|
- Fetch manga info from MangaDex in forum channels dedicated for manga
|
||||||
|
- Also edits title to the English MangaDex title
|
||||||
|
- Yuri, of course
|
||||||
|
- Maybe more to come, if I think of any more features
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
### Requirements
|
||||||
|
- Python 3.11
|
||||||
|
- pipenv
|
||||||
|
|
||||||
|
### How to run
|
||||||
|
1. `git clone https://git.mnau.xyz/hernik/maple && cd maple`
|
||||||
|
2. `pipenv install --dev`
|
||||||
|
3. `pipenv run python main.py`
|
Loading…
Reference in a new issue