From b62ab783255bae1cac86c703cd24b1da4b01910d Mon Sep 17 00:00:00 2001 From: Louis Hollingworth Date: Wed, 3 May 2023 20:09:11 +0100 Subject: [PATCH] Updated README and CONTRIBUTING to have correct repository info Signed-off-by: Louis Hollingworth --- CONTRIBUTING.md | 4 ++-- README.md | 18 ++++++++++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0632b8c..c9ce406 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ # How to contribute -Contributions to are highly encouraged and desired. Below are some guidelines that will help make the process as smooth as possible. +Contributions to ER are highly encouraged and desired. Below are some guidelines that will help make the process as smooth as possible. ## Getting Started -- Make sure you have a [GitHub account](https://github.com/signup/free) +- Make sure you have a [Ludo Git account](https://git.ludoviko.ch/user/sign_up) - Submit a new issue, assuming one does not already exist. - Clearly describe the issue including steps to reproduce when it is a bug. - Make sure you fill in the earliest version that you know has the issue. diff --git a/README.md b/README.md index e6436c3..8319d15 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ -# template -A general template repo +# ER - Edvin Rydburg +A Discord bot designed around the [Young Royals](https://discord.gg/youngroyals) +Discord guild. This bot is the first generation of what will become Klara. + +The intent for this bot is as a playground for features of the future Klara bot +that will be written in Rust or Go. + +## Why TS/JS then Rust or Go? +Discordx makes it extremely easy to build a bot, so while I'm figuring things +out, this will ensure that I can quickly realise what will be needed. Once what +is needed is known, a more stable version can be made that, in Rust or Go, will +consume far less resources. + +## Will the future Klara still be open-source? +Yes! Of course! Practically everything I do is open-source, I don't believe that +hiding work particularly helps anyone.