From 6c48eb11ac60a46b03704a6cb13b7105c2c28425 Mon Sep 17 00:00:00 2001 From: Victor Mignot Date: Wed, 1 Jan 2025 15:57:28 +0100 Subject: [PATCH] Update README --- README.md | 38 ++++++-------------------------------- 1 file changed, 6 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index a8f8aeb..590e032 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,9 @@ -# YorokoBot +# Yorokobot -This bot is a remake of the original HokuBot -using Rust with the Serenity crate and the Nix package manager. +Yorokobot is a Discord bot that implement a topic-subscription systems. +It allows server owner to create a list of custom topics to which users can then subscribe. -The main instance of this bot was made specifically for the [Archetype:Moon](https://archetype-moon.fr/) -server and is not public. -If you want to add the bot to your own server (or host a public version), you can run your own instance -of Yorokobot as long as the license terms are respected. +## Licensing -## What is YorokoBot ? - -YorokoBot is a Discord bot allowing users to subscribe to tags. -Tags represent someone's center of interest. -If something related to this topic is post on Discord, the sender can use -the bot to ping each users that subscribed to this topic. - -## Why using YorokoBot when Discord roles exist ? - -To keep it simple, to prevent a Discord server to create a ton of roles. - -## How Yorokobot permissions are managed ? - -Yorokobot has no permission management system. -Discord provides for each server a way to handle who can use a specific command and on which channel. -Once the bot in on your server, you can do a right click on the bot user and select "Manage integration". - -## Is there a global banlist ? - -No, at least for now. - -## Why is not the main bot instance public ? - -I'm currently a student and this is just a project I did because it would be useful for the Archetype-Moon Discord server. -However, it was important for me to make it available to everyone who wanted to use it as long as they are ready to run it themselves. +This project is licensed under the `European Union Public License v. 1.2`. +Please refer to the `LICENSE` file if needed.