Update readme.md
This commit is contained in:
parent
8074ae1971
commit
93c9a797ee
28
readme.md
28
readme.md
|
@ -2,16 +2,16 @@
|
||||||
|
|
||||||
A kitchen-sink discord bot designed to replace [Skyra](https://skyra.pw) v7 for use in the [HC](https://discord.gg/utgAEV2) network.
|
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 Java, using [JDA](https://github.com/DV8FromTheWorld/JDA). User feedback is greatly encouraged!
|
It's written in Java, using [JDA](https://github.com/DV8FromTheWorld/JDA).
|
||||||
|
|
||||||
### Credits & Thanks
|
## Features
|
||||||
|
|
||||||
+ [oko](https://oko.moe)
|
+ The expected utility command suite.
|
||||||
+ [Tiddy](https://tiddy.oko.moe)
|
+ Music functionality using Lavaplayer.
|
||||||
+ [Laika](http://alpinia.link)
|
+ Member Leave/Join logging.
|
||||||
+ [Favna](https://favware.tech), for maintaining [Ribbon](https://github.com/favna/ribbon) from 2017-2019, & Skyra to this day!
|
+ Channel/Conversation archival and export.
|
||||||
|
|
||||||
### Installation
|
## Installation
|
||||||
|
|
||||||
1. Download from the [Releases](https://fem.mint.lgbt/oko/kiafumi/releases), or compile with `maven clean package`.
|
1. Download from the [Releases](https://fem.mint.lgbt/oko/kiafumi/releases), or compile with `maven clean package`.
|
||||||
2. Run `Kiafumi-x.x.jar` in an empty directory.
|
2. Run `Kiafumi-x.x.jar` in an empty directory.
|
||||||
|
@ -19,5 +19,17 @@ It's written in Java, using [JDA](https://github.com/DV8FromTheWorld/JDA). User
|
||||||
4. Open and configure the generated `config.yml`.
|
4. Open and configure the generated `config.yml`.
|
||||||
5. Run `Kiafumi-x.x.jar` again.
|
5. Run `Kiafumi-x.x.jar` again.
|
||||||
|
|
||||||
### License
|
## Credits & Thanks
|
||||||
|
|
||||||
|
+ [oko](https://oko.moe)
|
||||||
|
+ [Tiddy](https://tiddy.38.fail)
|
||||||
|
+ [Laika](http://alpinia.link), for writing the groundwork of the Java fork.
|
||||||
|
+ [Favna](https://favware.tech), for maintaining [Ribbon](https://github.com/favna/ribbon) from 2017-2019, & Skyra to this day!
|
||||||
|
|
||||||
|
### Feedback
|
||||||
|
|
||||||
|
Feedback from anyone, from bug reports to feature requests, is greatly encouraged. You can contact us with the [Issues](https://fem.mint.lgbt/oko/kiafumi/issues) page, or reach `oko#0994` on discord.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
Copyright © 2022 oko, under the [ISC License](./LICENSE)
|
Copyright © 2022 oko, under the [ISC License](./LICENSE)
|
Loading…
Reference in a new issue