From 2b74adadeb5aa8a1c27c7fe448561e4fb856b24b Mon Sep 17 00:00:00 2001 From: Jude Southworth Date: Fri, 2 Oct 2020 14:19:53 +0000 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f769ad0..1587a53 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ # reminder-rs -Reminder Bot for Discord, now in Rust +Reminder Bot for Discord, now in Rust. +Old Python version: https://github.com/reminder-bot/bot + +## What is this? +This is a rewrite of Reminder Bot in Rust, using Serenity and SQLx amongst other libraries. + +## Why is this? +Serenity and Rust are proving wonders for SoundFX. This is all in an effort to reduce resource consumption and improve performance. + +## How do I use it? +You'll need rustc and cargo for compilation. To run, you'll need Python 3 still (due to no suitable replacement for dateparser in Rust) + +TODO fill out the rest of this