From b8e0b9a1c82729a6a74198f96c72f1806a68bb85 Mon Sep 17 00:00:00 2001 From: oko Date: Mon, 28 Mar 2022 23:24:25 -0700 Subject: [PATCH] Update readme.md --- readme.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 11d887f..dd650ff 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,23 @@ # Kiafumi + A kitchen-sink discord bot designed to replace [Skyra](https://skyra.pw) v7 for use in the [HC](https://discord.gg/utgAEV2) network. -It's written in [JDA](https://github.com/DV8FromTheWorld/JDA) and is intended to be resource conscious where possible. +It's written in Java, using [JDA](https://github.com/DV8FromTheWorld/JDA). User feedback is greatly encouraged! ### Credits & Thanks + + [oko](https://oko.moe) (Development + Moral Support) + [Tiddy](https://tiddy.oko.moe) (Development + Being an Angel) + [Laika](http://alpinia.link) (Development + Java Shenanigans) + [Favna](https://favware.tech), for maintaining [Ribbon](https://github.com/favna/ribbon) from 2017-2019, & Skyra to this day! +### Installation + +1. Download from the [Releases](https://fem.mint.lgbt/oko/kiafumi/releases), or compile with `mvn clean package`. +2. Run `Kiafumi-x.x.jar` in an empty directory. +3. Create a new MariaDB(**Not** MySQL) database. +4. Open and configure the generated `config.yml`. +5. Run `Kiafumi-x.x.jar` again. + ### License Copyright © 2022 oko, under the [ISC License](./LICENSE) \ No newline at end of file