Add README

K-Lqrs · Aug 22, 2024 · 92e7ac5 · 92e7ac5
1 parent b7cbe12
commit 92e7ac5
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Fabricord
+A modern message style like DiscordSRV will be reproduced as a Fabric version mod.
+
+
+![GitHub License](https://img.shields.io/github/license/KT-Ruxy/Fabricord?style=plastic&logo=github&link=https%3A%2F%2Fgithub.com%2FKT-Ruxy%2FFabricord%2Fblob%2Fkotlin%2FLICENSE) ![GitHub release (with filter)](https://img.shields.io/github/v/release/Elysium-7/Fabricord?style=plastic) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/Elysium-7/Fabricord?style=plastic)
+
+## Overview
+Fabricord is a mod of DiscordSRV for FabricServer that bridges Discord and FabricServer chats to each other for a better communication experience.
+
+## Features
+- Read each other's chat messages between Fabric servers and Discord channels.
+- Modern, visually active message style.
+- Easy user mentions system from within Minecraft using role IDs and user IDs.
+- Send messages of death and achievement acquisition
+## Installation
+Setup is very easy. !
+- install the Mod on the server and start it once.
+
+  ┗The first time you start the mod, a configuration file will be generated automatically.
+- open config.yml in the server root/fabricord
+- enter BotToken/Log_Channel_ID as a minimum.
+- and start the server again.
+
+There are other settings that can be configured.
+Refer to Modrinth for message styles.
+
+## License
+Fabricord is available under the [Apache License](https://github.com/KT-Ruxy/Fabricord/blob/next-gen/LICENSE).